From 8e5d6fe026e279bd1f38c2292166700f9eb5531c Mon Sep 17 00:00:00 2001 From: PJ Fanning Date: Tue, 8 Jul 2025 03:40:26 +0100 Subject: [PATCH 1/2] update docs --- .asf.yaml | 1 - src/documentation/publish-poi-site.txt | 23 ++++++++++++++++++----- 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/.asf.yaml b/.asf.yaml index 613368f48e..1a86da9ed9 100644 --- a/.asf.yaml +++ b/.asf.yaml @@ -44,4 +44,3 @@ notifications: publish: whoami: asf-site - subdir: publish diff --git a/src/documentation/publish-poi-site.txt b/src/documentation/publish-poi-site.txt index c60cd7918b..c0456e77d9 100644 --- a/src/documentation/publish-poi-site.txt +++ b/src/documentation/publish-poi-site.txt @@ -47,15 +47,28 @@ Building and Deploying the Site It is recommended that you open a command prompt and set up Java 8 as your default. The web site build will fail if you use a very recent Java version. -In your local copy of the POI svn (https://github.com/apache/poi/tree/trunk), run: +In your local copy of the POI git (https://github.com/apache/poi/tree/trunk), run using Java 8: ant site -After this completes, you can copy the files in `build/site` to the `publish` directory in your poi-site checkout -(https://github.com/apache/poi/tree/asf-site). +If you use a newer version, you will get warnings and the output will have issues. + +After this completes, you can switch to the `asf-site` branch. + +The `ant site` command will have created a directory called `build/site` in your local POI git checkout. +You can copy the files in `build/site` to the `content` directory. +This `content` directory is where the files for the web site are stored +and only appears in the `asf-site` branch. A command like this might work. -cp -r ~/poi/build/site/* ~/poi-site/publish/ +cp -R build/site/* content/ -I would recommend that you use `git status` and `git diff` before committing the changes to poi-site. +I would recommend that you use `git status` and `git diff` before committing the changes to asf-site. + +It is probably a good idea to check the site locally before committing the changes by opening the +content/index.html file in a browser. + +Once you are happy with the changes, you can commit them to the `asf-site` branch. + +It is probably a good idea to merge the changes to the `trunk` branch as well but that won't affect the web site. From f76089be670e4c2479ec88119ac41a04f3006892 Mon Sep 17 00:00:00 2001 From: PJ Fanning Date: Tue, 8 Jul 2025 03:44:08 +0100 Subject: [PATCH 2/2] rename xml file --- .../content/xdocs/devel/{subversion.xml => git.xml} | 0 src/documentation/content/xdocs/devel/index.xml | 2 +- src/documentation/content/xdocs/site.xml | 2 +- 3 files changed, 2 insertions(+), 2 deletions(-) rename src/documentation/content/xdocs/devel/{subversion.xml => git.xml} (100%) diff --git a/src/documentation/content/xdocs/devel/subversion.xml b/src/documentation/content/xdocs/devel/git.xml similarity index 100% rename from src/documentation/content/xdocs/devel/subversion.xml rename to src/documentation/content/xdocs/devel/git.xml diff --git a/src/documentation/content/xdocs/devel/index.xml b/src/documentation/content/xdocs/devel/index.xml index 819e7a4c44..4b3acd2783 100644 --- a/src/documentation/content/xdocs/devel/index.xml +++ b/src/documentation/content/xdocs/devel/index.xml @@ -62,7 +62,7 @@

The main Apache POI build was traditionally done with Apache Ant. In 2021, we moved to using Gradle. - After checking out the POI code, you will find gradlew and + After checking out the POI code, you will find gradlew and gradlew.bat. These command files are used for running Gradle on Linux/Mac and Windows respectively. Gradlew checks if you the right version of Gradle installed and will install it if you don't.

diff --git a/src/documentation/content/xdocs/site.xml b/src/documentation/content/xdocs/site.xml index e7f10e9379..3bfb5efbe7 100644 --- a/src/documentation/content/xdocs/site.xml +++ b/src/documentation/content/xdocs/site.xml @@ -124,7 +124,7 @@ See https://xml.apache.org/forrest/linking.html for more info - +