Author: fanningpj
Date: Sat Sep 23 09:53:45 2023
New Revision: 1912490
URL: http://svn.apache.org/viewvc?rev=1912490&view=rev
Log:
add site doc
Added:
poi/site/src/documentation/publish-poi-site.txt
Added: poi/site/src/documentation/publish-poi-site.txt
URL:
http://svn.apache.org/viewvc/poi/site/src/documentation/publish-poi-site.txt?rev=1912490&view=auto
==============================================================================
--- poi/site/src/documentation/publish-poi-site.txt (added)
+++ poi/site/src/documentation/publish-poi-site.txt Sat Sep 23 09:53:45 2023
@@ -0,0 +1,61 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+
+ ==============================
+ Publishing POI Web Site
+ ==============================
+
+The Apache POI web site is https://poi.apache.org/
+
+The HTML and other files for the web site are stored in svn at
https://svn.apache.org/repos/asf/poi/site
+Committing files to the `publish` directory of this repo will automatically
lead to the web site being updated.
+There may be a small delay and you might need to force a refresh in your
browser.
+
+The site is built from using the main POI svn at
https://svn.apache.org/repos/asf/poi/trunk
+
+Prerequisites
+-------------
+
+You will need an up to date version of Apache Ant installed (Ant 1.10 works
well).
+You also need to install Apache Forrest. Forrest is no longer maintained but
PJ has a fork with a few small changes.
+This is at https://github.com/pjfanning/apache-forrest-0.9
+
+You can use the last official Apache Forrest release but you may notice some
diffs when you build the site and try to
+publish it. https://forrest.apache.org/
+
+You will need to create an environment variable called FORREST_HOME and set it
to match the directory location
+where you installed Apache Forrest.
+
+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://svn.apache.org/repos/asf/poi/trunk), run:
+
+ant site
+
+After this completes, you can copy the files in `build/site` to the `publish`
directory in your poi-site checkout
+(https://svn.apache.org/repos/asf/poi/site).
+
+A command like this might work.
+
+cp -r ~/svn/poi/build/site/* ~/svn/poi-site/publish/
+
+I would recommend that you use `svn stat` and `svn diff` before committing the
changes to poi-site.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
