> -----Original Message----- > From: Daniel Frey [mailto:[EMAIL PROTECTED] > Sent: Friday, March 12, 2004 10:40 AM > To: 'Avalon framework users' > Subject: Site docu > > Hi there, > > Can somebody give me a hint on how-to build the site documentation out of > the source? The documentation "CVS Build" does not mention that... > > Thanks, Daniel
Site documentation is can be broken up into two categories: 1. General site information (the main links on http://avalon.apache.org) 2. Project-specific documentation (things like http://avalon.apache.org/maven) Project specific docs are located with the project's source code, generally in a directory named "xdocs" but this may very slightly from project to project -- something we certainly want to standardize at some point. 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: maven site:generate The documentation will be generated and placed it 'target/docs'. 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 : 1. Update the source XML files 2. Generate the HTML results from the XML using maven 3. Copy or import the new HTML into the avalon-site/site directory 4. Commit both the new avalon-site/site HTML and the source XML changes. Other details at: http://wiki.apache.org/avalon/SiteUpdateProcess J. Aaron Farr SONY ELECTRONICS DDP-CIM (724) 696-7653 --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
