$Id$

The Jakarta Website Instructions
--------------------------------

***NOTE***
DO NOT EDIT THE .html files in /www/jakarta.apache.org.
Please follow the directions below for updating the website.
***NOTE***

The Jakarta website is based on .xml files which are transformed
into .html files using XSLT via an Ant task. 

In order to make modifications to the Jakarta website, you need
to first check out the jakarta/site module from SVN:

svn co https://svn.apache.org/repos/asf/jakarta/site/

Once you have the site checked out locally, cd into your 
site directory and execute:

ant

This will build the documentation into the docs/ directory. The output 
will show you which files got re-generated.

If you would like to make modifications to the website documents,
you simply need to edit the files in the xdocs/ directory.

The files in xdocs/stylesheets are the global files for the site. If you make a 
modification to project.xml, it will affect the left side navigation for the 
website and all of your .html files will be re-generated. style.vsl is the 
template that controls the look and feel for the overall website. Editing 
this file will also cause all of the .html files to be re-generated as well.

Once you have built your documentation and confirmed that your changes are
ok, you can check your .xml and your .html files back into SVN. 

Then, in the /www/jakarta.apache.org/ directory, you can do a 
svn update index.html site
to have the changes reflected on the main website.