Author: kkolinko
Date: Wed Mar 11 12:26:37 2015
New Revision: 1665862
URL: http://svn.apache.org/r1665862
Log:
Describe how Tomcat documentation is built, to encourage submission of
documentation patches.
Modified:
tomcat/site/trunk/docs/bugreport.html
tomcat/site/trunk/xdocs/bugreport.xml
Modified: tomcat/site/trunk/docs/bugreport.html
URL:
http://svn.apache.org/viewvc/tomcat/site/trunk/docs/bugreport.html?rev=1665862&r1=1665861&r2=1665862&view=diff
==============================================================================
--- tomcat/site/trunk/docs/bugreport.html (original)
+++ tomcat/site/trunk/docs/bugreport.html Wed Mar 11 12:26:37 2015
@@ -897,23 +897,38 @@ bug in your web application.</p>
</p>
-<p>Here are some references:</p>
+<p>To patch and build Apache Tomcat see the following references:</p>
+
<ul>
<li>
-<p>Regarding Apache Tomcat:</p>
-
-<ul>
-
-<li>
<a href="svn.html">Subversion repository structure</a> of Apache Tomcat</li>
-
+
<li>Read BUILDING.txt in the source distribution</li>
-
+
</ul>
-
-</li>
+
+
+<p>To prepare a documentation patch:</p>
+
+
+<p>Read section on building the documentation in BUILDING.txt file
+ in the source distribution.
+ Usually the documentation for a version of Tomcat is located in
+ <code>webapps/docs/</code> directory in the source code and
+ can be built with <code>ant build-docs</code> command.</p>
+
+
+<p>To build documentation it should be sufficient to have a Java runtime
+ and a copy of <a href="http://ant.apache.org/";>Apache Ant</a>. Compiling
+ Tomcat code should be unnecessary.
+ </p>
+
+
+<p>Generic references:</p>
+
+<ul>
<li>
<p>Apache Software Foundation guildelines:</p>
Modified: tomcat/site/trunk/xdocs/bugreport.xml
URL:
http://svn.apache.org/viewvc/tomcat/site/trunk/xdocs/bugreport.xml?rev=1665862&r1=1665861&r2=1665862&view=diff
==============================================================================
--- tomcat/site/trunk/xdocs/bugreport.xml (original)
+++ tomcat/site/trunk/xdocs/bugreport.xml Wed Mar 11 12:26:37 2015
@@ -414,14 +414,28 @@ bug in your web application.</p>
command or <code>svn diff</code> or <code>git diff</code> command.
</p>
- <p>Here are some references:</p>
+ <p>To patch and build Apache Tomcat see the following references:</p>
+
+ <ul>
+ <li><a href="svn.html">Subversion repository structure</a> of Apache
Tomcat</li>
+ <li>Read BUILDING.txt in the source distribution</li>
+ </ul>
+
+ <p>To prepare a documentation patch:</p>
+
+ <p>Read section on building the documentation in BUILDING.txt file
+ in the source distribution.
+ Usually the documentation for a version of Tomcat is located in
+ <code>webapps/docs/</code> directory in the source code and
+ can be built with <code>ant build-docs</code> command.</p>
+
+ <p>To build documentation it should be sufficient to have a Java runtime
+ and a copy of <a href="http://ant.apache.org/";>Apache Ant</a>. Compiling
+ Tomcat code should be unnecessary.
+ </p>
+
+ <p>Generic references:</p>
<ul>
- <li><p>Regarding Apache Tomcat:</p>
- <ul>
- <li><a href="svn.html">Subversion repository structure</a> of Apache
Tomcat</li>
- <li>Read BUILDING.txt in the source distribution</li>
- </ul>
- </li>
<li><p>Apache Software Foundation guildelines:</p>
<ul>
<li>General <a
href="http://www.apache.org/dev/version-control.html#anon-svn";>Apache
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
