How To Update The Lucene Java Website
This page is obsolete.
(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). See [http://forrest.apache.org/docs_0_90/faq.html#oldjing Forrest FAQ] if you're getting "error: datatype library not recognized" errors during site build.
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
- Make your desired website changes to the source files in the subdirectory
- Optionally, run
forrest runand browse to
http://localhost:8888to 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
- Recursively copy
cp -r build/site/* docs
svn commitall changes (to the forrest sources and
The versioned site contains all files under the release dir
http://lucene.apache.org/java/X_Y_Z/, as created during the release process. Run
ant package to produce the binary release package, which contains the the Forrest-generated site, the javadocs, and the HTML-formatted versions of CHANGES.txt and contrib/CHANGES.txt (
Contrib-Changes.html). ReleaseTodo contains publication instructions for the versioned site: copy the contents of the
doc/ directory from the binary release package to
To make changes to the Forrest-generated site:
svn checkout https://svn.apache.org/repos/asf/lucene/dev/branches/lucene_solr_X_Y/lucene lucene-branch-X.Y(NOTE: this checks out the full lucene sources, not just the web site content, which is necessary for step 4 below)
- Follow instructions 3, 4 and 5 above to make your changes
svn commitall changes under
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:
exportLuceneDocs.sh looks like:
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
general@ lucene mailing lists.