Generating and Publishing Avalon Documentation

This HOWTO discusses how to generate and publish our documentation from the XML source files in CVS.

Generating Documentation

Site documentation is can be broken up into two categories:

The general documentation is in the avalon-site module. The newer documentation is under the 'xdocs' directory (not the 'src' directory which containers outdated information). To build this documentation use maven and run:

The documentation will be generated and placed it 'target/docs'.

Publishing Documentation to the Site

The contents under avalon-site/site are what end up being published to the website via a cron job (that does a CVS update). Therefore, to publish new documentation to the site, one needs to :

For project specific documentation, update the project's XML documentation and import the generated HTML into the appropriate location in the avalon-site/site CVS module.

SiteUpdateProcess (last edited 2009-09-20 23:16:58 by localhost)