[Lucene-java Wiki] Update of "HowToUpdateTheWebsite" by MikeMcCandless

[Apache Wiki <wi...@apache.org>]

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Lucene-java Wiki" for change notification.

The following page has been changed by MikeMcCandless:
http://wiki.apache.org/lucene-java/HowToUpdateTheWebsite

The comment on the change is:
Refactor the whole thing.

------------------------------------------------------------------------------
  
  ('''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 at http://lucene.apache.org/java/docs.
+ There are two separate subversion repositories that hold the content
+ for the Lucene java website (http://lucene.apache.org/java).
  
- First is the unversioned files at https://svn.apache.org/repos/asf/lucene/java/site, which contains all files under http://lucene.apache.org/java/docs.
+ In each case, [http://forrest.apache.org Apache Forrest] is required
+ to generate the docs.  You should install version 0.8.
  
- Second is https://svn.apache.org/repos/asf/lucene/java/trunk/src/site, which contains files versioned along with every release of Lucene java.  These appear under the release dir, eg http://lucene.apache.org/java/2_4_0, as created during the release process (see ReleaseTodo).  This site is also pushed nightly to http://lucene.apache.org/java/docs/nightly.
+ == Unversioned site ==
  
- Both of these sites are generated using [http://forrest.apache.org/ Apache Forrest].  To make a change to these sites:
+ The unversioned site contains all files directly under
+ http://lucene.apache.org/java/docs.  To make changes here:
  
-    1. Install [http://forrest.apache.org/ Apache Forrest] version 0.8
-    1. Checkout the content (see above for the subversion url to use).
-      1. svn co https://svn.apache.org/repos/asf/lucene/java/site site-unversioned
+   1. {{{svn checkout https://svn.apache.org/repos/asf/lucene/java/site site-unversioned}}}
-      1. svn co https://svn.apache.org/repos/asf/lucene/java/trunk/src/site site-versioned
-    1. Change the root forrest directory to one of the checked out directories.  For the versioned site, this is lucene/src/site (OG: where does "lucene" come from?  Is this specific to how one checks things out of svn?); for the unversioned site, it's main directory you just checked out (OG: main being "site-unversioned" ?).
-      1. cd site-unversioned
+   1. {{{cd site-unversioned}}}
-      1. cd site-versioned
-    1. Make your desired website changes to the source files in the subdirectory src/documentation (OG: in both checkouts?)
+   1. Make your desired website changes to the source files in the subdirectory {{{src/documentation}}}
-    1. 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.
+   1. 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.
-    1. When you are satisfied with your changes, stop the forrest server and then regenerate the site by running "forrest site".  Then, recursively copy site-versioned/build/site/* to ../../docs/* (for the versioned site) (OG: is ../../docs/ specific to some specific way of checking out of svn? e.g. this doesn't work with exaple svn co commands above) and docs/* (for the unversioned site), and commit changes to both src/documentation and docs (add any new files first, but exclude the build directory).
-    1. The site will automatically be exported from svn to people.apache.org by a script running in Grant's crontab on p.a.o., and then Apache's main web servers will reflect the change within an hour according to the process described at http://www.apache.org/dev/project-site.html).  Grant's cron job currently (as of 1/22/2009) looks like this:
+   1. When you are satisfied with your changes, stop the forrest server and then regenerate the site by running {{{forrest site}}}
+   1. Recursively copy {{{build/site/*}}} to {{{docs/*}}} by running {{{cp -r build/site/* docs}}}
+   1. {{{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:
+ 
+   1. {{{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)
+   1. {{{cd lucene/src/site}}}
+   1. Follow instructions 3, 4 and 5 above to make your changes
+   1. Recursively {{{copy build/site/*}}} to {{{../../docs/*}}} by running {{{cp -r build/site/* ../../docs}}}
+   1. {{{svn commit}}} all changes (to the forrest sources and {{{../../docs/*}}})
+ 
+ == Production push ==
+ 
+ After committing the changes, you are 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
+ And, {{{exportLuceneDocs.sh}}} looks like:
  
  {{{
  #!/bin/sh
@@ -35, +50 @@

  /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. 
+ 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.