Avalon Doc Management System

[Leo Simons <le...@apache.org>]

well, it is barely a system. I saw someone say somewhere they didn't get 
how to build the site. Anyways, readme.txt upped. Included below for 
even more convenience.

- LSD

		"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.

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.

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:

	export CVS_RSH=ssh
	cd $DIR_WHERE_DOCS_WHERE_BUILT
	cvs -d $yourid@cvs.apache.org:/home/cvs import \
		jakarta-avalon-site/site/$APPROPRIATELOCATION $yourname $yourtag

ie, to update the logkit documentation on the website

	export CVS_RSH=ssh
	export ASFROOT=leosimons@cvs.apache.org:/home/cvs
	cd jakarta-avalon-logkit
	ant docs
	cd build/docs
	cvs -d $ASFROOT import jakarta-avalon-site/site/logkit \
		leosimons lsd
	ssh leosimons@daedalus.apache.org
	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 leosimons@daedalus.apache.org
	cd /www/avalon.apache.org
	cvs up -P -d



---------------------------------------------------------------------
To unsubscribe, e-mail: avalon-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: avalon-dev-help@jakarta.apache.org

RE: Avalon Doc Management System

[Leo Sutic <le...@inspireinfrastructure.com>]

> From: news [mailto:news@main.gmane.org] On Behalf Of Leo Simons
> 
> I saw someone say somewhere they didn't get how to build the site. 

Thanks!

/LS


---------------------------------------------------------------------
To unsubscribe, e-mail: avalon-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: avalon-dev-help@jakarta.apache.org