At 06:50 PM 9/11/2003 +1000, Paul Smith wrote:
This all seems fairly easy, I'll stick with this, at the very least it's familiar to Apache developers.
Good.
Ceki, if I start creating directories and modifying the site navigation to include a new Chainsaw area, will it automatically start updating the Jakarta site? (I've heard it does it automatically).
No. You will have to upload the documentation using 'scp'.
Once the docs are generated, the command I use is:
~/log4j/docs > scp index.html [EMAIL PROTECTED]/www/jakarta.apache.org/log4j/docs
You can also upload multiple html files at once as in:
~/log4j/docs > scp *.html [EMAIL PROTECTED]/www/jakarta.apache.org/log4j/docs
scp usually comes with ssh.
How do I generate the Log4j site locally so I can test out what the site looks like before a commit?
Here is the procedure.
- Get the jakarta-site2 module using CVS.
- Assuming the files are in /jakarta-site2/, then set the jakarta.site2 variable in build.properties:
jakarta-site2=/jakarta-site2
- Generate the site, using ant. The command is "ant site2".
You can change/add files under LOG4J_HOME/src/xdocs/. The corresponding html files will be generated into LOG4J_HOME/docs/
Let me know if you run into trouble.
cheers, and thanks for the help offer. I am commited to making the documentation as good as can be. I'd be a hyprocrit if I shake my head at some other Projects documentation (apache one's included) and go ahead and produce crap documentation myself... :)
Writing docs is not hard, it is just boring.
cheers,
Paul
-- Ceki Gülcü
For log4j documentation consider "The complete log4j manual"
ISBN: 2970036908 http://www.qos.ch/shop/products/clm_t.jsp See you in November at ApacheCon US 2003 in Las Vegas.
http://apachecon.com/--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
