[Mark was faster, but since I already wrote this I'll send anyhow]
Hi Chris,
On 17.03.2009 14:37, Christopher Schultz wrote:
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Tomcat committers,
What is the best way to submit a patch for the Tomcat website docs --
like ones that are linked-to from this page:
http://tomcat.apache.org/tomcat-6.0-doc/index.html
Lots of complaints are made on the list about docs missing important
information, giving the wrong impression, etc. and the response is
always "patches are always welcome".
The SVN tree doesn't appear to contain the website, even under the
"site" tree. There are some files in there, but not all of the config
references and stuff like that.
I'd love to submit a patch or two but I'm not sure where to get the
current version. Should we just grab the latest version off the website
and send-in a diff against that?
The website is produced out of xml files. So best would be patches
against those. Here's the recipe for the docs part of the website.
You'll need a subversion client and ant.
- Check out https://svn.apache.org/repos/asf/tomcat/tc6.0.x/trunk
svn checkout https://svn.apache.org/repos/asf/tomcat/tc6.0.x/trunk
- Go to the source directory for the docs
cd trunk/webapps/docs
If you want to change a file, which is named e.g. introduction.html on
the docs website, look for introduction.xml in this directory. The
internal structure of the files is relatively simple and close to html.
- Edit the file you want.
- Generate the html docs
The docs are generated using a style sheet named tomcat-docs.xsl in this
directory.
Go to the trunk main directory. Ensure Java 5 is in your path and ant is
available. Then do
ant build-prepare
which will once create a couple of target directories, and then
ant build-docs
whenever you changed something to the docs. The result should appear in
output/build/webapps/docs
- Check whether the result look fine.
- Supply patches
by going to the source directory
cd webapps/docs
and then doing
svn diff
Hope that works for you?
Regards,
Rainer
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscr...@tomcat.apache.org
For additional commands, e-mail: users-h...@tomcat.apache.org
