HOWTO for JDO Site
==================

Maven1 "site" plugin
--------------------

The documentation is converted for display by the Maven1 "site" plugin.
Apache JDO use of site revolves around 3 files
1) xdocs/navigation.xml : this defines what appears where in the side menu
   When adding a new doc, make sure you add a reference to it in this file.

2) xdocs/site.jsl : this defines how the side menu, header and body are
   merged by "maven site". Only change this if you want to alter the
   overall site layout.

3) xdocs/style/*.css : CSS files defining fonts, colours etc for display


How to change the site content and generate ?
---------------------------------------------

1) Make your modifications to the source xml file in xdocs/
2) Run Maven1 "site"

    $ maven -o clean site

3) If errors, fix and repeat step 2

4) Check the generated site in "target/docs" using
   your browser.

5) If all ok, copy the generated site into the SVN locations by
    $ maven -o savesite

6) Commit all changes to SVN (all changes under "xdocs" as well as
   all generated "docs").


How to update the javadoc
-------------------------

1) Generate javadoc in the api20 trunk subproject:
   cd jdo/trunk/api20; maven javadoc

2) Copy the api20 javadoc results to the site/docs directory: 
   cp -r jdo/trunk/api20/target/docs/apidocs jdo/site/docs/api20

3) Generate javadoc in the api11 trunk subproject:
   cd jdo/trunk/api11; maven javadoc

4) Copy the api11 javadoc results to the site/docs directory: 
   cp -r jdo/trunk/api11/target/docs/apidocs jdo/site/docs/api11


How do I deploy site to the internet?
-------------------------------------

1) Once all changes are committed to subversion, ssh into 
   people.apache.org

2) cd /www/db.apache.org/jdo

3) `cat UPDATE`

That should bring all the changed content from SVN.  You must then 
wait for up to 4 hours for the sync to take place to the real website