leosimons 2003/02/03 12:04:03 Modified: . README.txt Log: docs docs docs. writing docs rocks. Revision Changes Path 1.2 +46 -6 jakarta-avalon-site/README.txt Index: README.txt =================================================================== RCS file: /home/cvs/jakarta-avalon-site/README.txt,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- README.txt 26 Dec 2002 15:52:11 -0000 1.1 +++ README.txt 3 Feb 2003 20:04:02 -0000 1.2 @@ -1,10 +1,50 @@ -$Id$ + "Avalon Site Management System" + =============================== +Be sure to read www.apache.org/dev/, xml.apache.org/forrest/, +and jakarta.apache.org/site/jakarta-site2.html for info. -The files in this directory are for getting you up to speed -quickly if you choose to use this system to render your website. +This cvs module is used for managing avalon.apache.org (and also for +jakarta.apache.org/avalon for now). The docroot of avalon.apache.org is +on daedalus, /www/avalon.apache.org. This docroot is a checkout of +jakarta-avalon-site/site. -You can find out more information by going to this website: +The docs are maintained in xml form. Most are closely bound with their project, +for example, docs for logkit are in jakarta-avalon-logkit/src/xdocs. You can +use the build systems of the various projects to transform these docs into html. +Then, use cvs import to update the contents of ./site: -http://jakarta.apache.org/site/jakarta-site2.html + export CVS_RSH=ssh + cd $DIR_WHERE_DOCS_WHERE_BUILT + cvs -d $[EMAIL PROTECTED]:/home/cvs import \ + jakarta-avalon-site/site/$APPROPRIATELOCATION $yourname $yourtag -thanks! \ No newline at end of file +ie, to update the logkit documentation on the website + + export CVS_RSH=ssh + export [EMAIL PROTECTED]:/home/cvs + cd jakarta-avalon-logkit + ant docs + cd build/docs + cvs -d $ASFROOT import jakarta-avalon-site/site/logkit leosimns lsd + ssh [EMAIL PROTECTED] + cd /www/avalon.apache.org + cvs up -P -d + +The general site docs not associated with a particular project are kept in this +repo in src/documentation. You generate them using forrest. To do so, install +the latest forrest release (but not 0.3 as it is broken), add the forrest bin +dir to your path, then run it. + + export FORREST_HOME=/opt/forrest # where-ever you installed it + export PATH=$PATH:$FORREST_HOME/bin + cd jakarta-avalon-site + forrest + +this generates the docs in the appropriate location. Now commit these to the repo +and update daedalus. + + cd site + cvs -d $ASFROOT commit -R -m 're-gen docs' * + ssh [EMAIL PROTECTED] + cd /www/avalon.apache.org + cvs up -P -d
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
