Return-Path: Mailing-List: contact site-cvs-help@jakarta.apache.org; run by ezmlm Delivered-To: mailing list site-cvs@jakarta.apache.org Received: (qmail 86962 invoked by uid 500); 26 Nov 2000 07:08:12 -0000 Delivered-To: apmail-jakarta-site2-cvs@apache.org Received: (qmail 86959 invoked by uid 1047); 26 Nov 2000 07:08:12 -0000 Date: 26 Nov 2000 07:08:11 -0000 Message-ID: <20001126070811.86958.qmail@locus.apache.org> From: jon@locus.apache.org To: jakarta-site2-cvs@apache.org Subject: cvs commit: jakarta-site2/docs README.txt jon 00/11/25 23:08:11 Added: docs README.txt Log: moved to the right directory and also fixed the cvs -d option Revision Changes Path 1.1 jakarta-site2/docs/README.txt Index: README.txt =================================================================== $Id: README.txt,v 1.1 2000/11/26 07:08:11 jon Exp $ 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 Anakia. Anakia is simply an Ant task that performs the transformations using JDOM and Velocity. In order to make modifications to the Jakarta website, you need to first check out the jakarta-site2 module from CVS: cvs -d /home/cvs login cvs -d /home/cvs co jakarta-site2 Once you have the site checked out locally, cd into your jakarta-site2 directory and execute: ./build.sh 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 CVS. Then, in the /www/jakarta.apache.org/site/ directory, you can do a cvs update -d -P to have the changes reflected on the main website. For the homepage, you should execute: cd /www/jakarta.apache.org; cvs update index.html The reason that it is different for each one is because CVS is a recursive function by nature and you don't want to have to deal with cvs potentially going through all of the directories in the website. :-)