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

Maven "site" plugin
-------------------

The documentation is generated for display by the Maven "site" plugin.
Apache JDO use of site revolves around 
1) pom.xml : defines the overall site project

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

The content in docs is linked via the svn:externals property to
https://svn.apache.org/repos/infra/websites/production/db/content/jdo.

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

1) Make your modifications to the source xml files in src/site/xdoc/
2) Run Maven "site"

    $ mvn -o clean site

3) If errors, fix and repeat step 2

4) Check the generated site in "target/site" using
   your browser. Open index.html to view the site from the top level page.

5) If all ok, copy the generated site into the SVN locations by
    $ cp -R target/site/* docs/

6) Do an svn add on all new files in both site/docs and site/src/xdocs.

7) Commit all changes to SVN (all changes under "src" as well as all generated "docs"). You may have to do a separate commit for docs because it refers to a separate repository.


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