How To Update The Lucene Java Website
(NOTE: You need committer rights to modify the Lucene Website.)
There are two separate subversion repositories that hold the content for the Lucene java website (http://lucene.apache.org/java).
In each case, Apache Forrest is required to generate the docs. You should install version 0.8. (0.8 requires Java 1.5 and will not work with 1.6)
Unversioned site
The unversioned site contains all files directly under http://lucene.apache.org/java/docs. To make changes here:
svn checkout https://svn.apache.org/repos/asf/lucene/java/site site-unversioned
cd site-unversioned
Make your desired website changes to the source files in the subdirectory src/documentation
Optionally, run forrest run and browse to http://localhost:8888 to review the changes and iterate. You should be able to modify the source documents and hit reload on your browser to see the changes.
When you are satisfied with your changes, stop the forrest server and then regenerate the site by running forrest site
Recursively copy build/site/* to docs/* by running cp -r build/site/* docs
svn commit all changes (to the forrest sources and docs/*)
Versioned site
The versioned site contains all files under the release dir, for example http://lucene.apache.org/java/2_4_1, as created during the release process (see ReleaseTodo). To make changes here:
svn checkout https://svn.apache.org/repos/asf/lucene/java/trunk lucene (NOTE: this checks out the full lucene sources, not just the web site content, which is necessary for step 4 below)
cd lucene/src/site
- Follow instructions 3, 4 and 5 above to make your changes
Recursively copy build/site/* to ../../docs/* by running cp -r build/site/* ../../docs
svn commit all changes (to the forrest sources and ../../docs/*)
Production push
After committing the changes, you just need to wait for Grant's nightly cronjob, which copies the versioned & unversioned files to people.apache.org:/www/lucene.apache.org/java/*. Then the changes are pushed to Apache's main web servers (described at http://www.apache.org/dev/project-site.html).
Grant's cron job currently (as of 3/13/2009) looks like this:
03 6 * * * <OMITTED>/bin/exportLuceneDocs.sh > /tmp/lucene-nightly.log 2>&1
And, exportLuceneDocs.sh looks like:
/usr/local/bin/svn export --force http://svn.apache.org/repos/asf/lucene/java/site/docs /www/lucene.apache.org/java/docs /usr/local/bin/svn export --force http://svn.apache.org/repos/asf/lucene/java/trunk/docs /www/lucene.apache.org/java/docs/nightly
If the reason for updating the site was to post some sort of significant new news (e.g.: a release, a new committer, an upcoming talk, etc...) or to add completely new documentation consider sending out an announcement email to the java-user@, java-dev@, and general@ lucene mailing lists.