1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html lang="en"><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><link href="../images/docs-stylesheet.css" rel="stylesheet" type="text/css"><title>The Apache Tomcat Connectors - Miscellaneous Documentation (1.2.50) - How to Contribute to the Documentation</title><meta name="author" content="Robert Sowders"></head><body><div id="wrapper"><header><div id="header"><div><div><div class="logo noPrint"><a href="http://tomcat.apache.org/"><img alt="Tomcat Home" src="../images/tomcat.png"></a></div><div style="height: 1px;"></div><div class="asfLogo noPrint"><a href="https://www.apache.org/" target="_blank"><img src="../images/asf-logo.svg" alt="The Apache Software Foundation" style="width: 266px; height: 83px;"></a></div><h1>The Apache Tomcat Connectors - Miscellaneous Documentation</h1><div class="versionInfo">
Version 1.2.50,
<time datetime="2024-08-08">Aug 8 2024</time></div><div style="height: 1px;"></div><div style="clear: left;"></div></div></div></div></header><div id="middle"><div><div id="mainLeft" class="noprint"><div><nav><div><h2>Links</h2><ul><li><a href="../index.html">Docs Home</a></li></ul></div><div><h2>Common HowTo</h2><ul><li><a href="../common_howto/quick.html">Quick Start</a></li><li><a href="../common_howto/workers.html">All About Workers</a></li><li><a href="../common_howto/timeouts.html">Timeouts</a></li><li><a href="../common_howto/loadbalancers.html">Load Balancing</a></li><li><a href="../common_howto/proxy.html">Reverse Proxy</a></li></ul></div><div><h2>Web Server HowTo</h2><ul><li><a href="../webserver_howto/apache.html">Apache HTTP Server (mod_jk)</a></li><li><a href="../webserver_howto/iis.html">Microsoft IIS (ISAPI redirector)</a></li></ul></div><div><h2>Reference Guide</h2><ul><li><a href="../reference/workers.html">workers.properties</a></li><li><a href="../reference/uriworkermap.html">uriworkermap.properties</a></li><li><a href="../reference/status.html">Status Worker</a></li><li><a href="../reference/apache.html">Apache HTTP Server (mod_jk)</a></li><li><a href="../reference/iis.html">Microsoft IIS (ISAPI redirector)</a></li></ul></div><div><h2>AJP Protocol Reference</h2><ul><li><a href="../ajp/ajpv13a.html">AJPv13 (ajp13)</a></li><li><a href="../ajp/ajpv13ext.html">AJPv13 Extension Proposal</a></li></ul></div><div><h2>Miscellaneous Documentation</h2><ul><li><a href="../miscellaneous/faq.html">Frequently Asked Questions</a></li><li><a href="../miscellaneous/changelog.html">Changelog</a></li><li><a href="http://issues.apache.org/bugzilla/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&product=Tomcat+Connectors&long_desc_type=substring&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&keywords_type=allwords&keywords=&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&emailassigned_to1=1&emailtype1=substring&email1=&emailassigned_to2=1&emailreporter2=1&emailcc2=1&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&field0-0-0=noop&type0-0-0=noop&value0-0-0=">Current Tomcat Connectors bugs</a></li><li><a href="../miscellaneous/doccontrib.html">Contribute documentation</a></li><li><a href="../miscellaneous/jkstatustasks.html">JK Status Ant Tasks</a></li><li><a href="../miscellaneous/reporttools.html">Reporting Tools</a></li></ul></div><div><h2>News</h2><ul><li><a href="../news/20240101.html">2024</a></li><li><a href="../news/20230101.html">2023</a></li><li><a href="../news/20200201.html">2020</a></li><li><a href="../news/20180301.html">2018</a></li><li><a href="../news/20160901.html">2016</a></li><li><a href="../news/20150101.html">2015</a></li><li><a href="../news/20140201.html">2014</a></li><li><a href="../news/20120301.html">2012</a></li><li><a href="../news/20110701.html">2011</a></li><li><a href="../news/20100101.html">2010</a></li><li><a href="../news/20090301.html">2009</a></li><li><a href="../news/20081001.html">2008</a></li><li><a href="../news/20070301.html">2007</a></li><li><a href="../news/20060101.html">2006</a></li><li><a href="../news/20050101.html">2005</a></li><li><a href="../news/20041100.html">2004</a></li></ul></div></nav></div></div><div id="mainRight"><div id="content"><h2>How to Contribute to the Documentation</h2><h3 id="Introduction">Introduction</h3><div class="text">
<p>
This document describes how you can easily contribute to the
documentation. I'm going to try to make it easy for everyone to help out with
the documentation of Tomcat, more specifically the documentation for the
connectors. This is written from a windows user perspective as I believe they
will most benefit from it. For people using Unix it should be easy for them to
apply these steps. Just substitute Unix syntax where needed.
</p>
<p>
The documentation is produced using xml with xsl style sheets. This
effectivly seperates the content of the documents from the style, so all that
contributers need to worry about the content. It is much easier to use than
html.
</p>
<p>
It's all really quite simple. Here is what you will need:
<ul>
<li>
<b>A recent version of Ant</b>
</li>
<li>
<b>The source code for the connectors from subversion</b>
</li>
<li>
<b>Any ascii text editor</b>
</li>
</ul>
</p>
</div><h3 id="Getting_Started_Step_by_Step">Getting Started Step by Step</h3><div class="text">
<p>
After you get these tools they are simple to set up.
</p>
<div class="subsection"><h4 id="STEP_1._Get_Ant">STEP 1. Get Ant</h4><div class="text">
<p>
Install <a href="http://ant.apache.org/">Ant</a>. The only advice I
have is to choose a simple installation path. Now set an environment variable
for ANT_HOME, and then add the location of the Ant/bin directory to your PATH
variable. Consult your Operating system documentation for information on how
to do this. When you are finished verify that you can run ant from the command
line.
</p>
<p>
Ant is used to build the documentation, among other things, and it must be
able to see a file called <b>build.xml</b>. This file is located in the
<b>xdocs</b> directory. In the
<b>build.xml</b> file there is a target named <b>all</b> that will be used to build
the docs.
</p>
</div></div>
<div class="subsection"><h4 id="STEP_2.__Get_the_sources">STEP 2. Get the sources</h4><div class="text">
<p>
Get the sources for
<a href="https://github.com/apache/tomcat-connectors">tomcat-connectors</a>
from the git repository. You will need a git client. Install the client of
your choice, if you don't already have one.
</p>
<p>
You are ready to download the sources now. Change directory to the
location where you want your repository to be. For simplicity we will call this
your <b>GIT_HOME</b>. Mine is located in C:\build.
</p>
<p>
Run the following command to <b>clone</b> the sources for the first time.
You should only need to do this once.
<div class="codeBox"><pre><code>C:\build\>git clone https://github.com/apache/tomcat-connectors tomcat-connectors
</code></pre></div>
</p>
<p>
You should now be watching all the downloads come in. Now that you have
the sources on your machine the hard part is over. From now on, to update your
sources all you have to do is cd into any directory in your repository and run
the <b>git pull</b> command.
</p>
</div></div>
<div class="subsection"><h4 id="STEP_3.__Test_your_build_environment">STEP 3. Test your build environment</h4><div class="text">
<p>
Open a command prompt window and cd to the directory where you downloaded
the source. Now cd into the xdocs directory so that <b>Ant</b> can see the
<b>build.xml</b> file. Then from a command prompt, run the following:
<div class="codeBox"><pre><code>C:\build\tomcat-connectors> cd xdocs
C:\build\tomcat-connectors\xdocs> ant all
</code></pre></div>
</p>.
<p>
You should see the ant compiler messages scrolling by rapidly and then stop
with the following:
<div class="codeBox"><pre><code>[style] Transforming into C:\build\tomcat-connectors\build\docs\news\printer>
[style] Processing C:\build\tomcat-connectors\xdocs\news\20041100.xml
to
C:\build\tomcat-connectors\build\docs\news/20041100.html
[style] Loading stylesheet C:\build\tomcat-connectors\xdocs\style.xsl
[style] Processing C:\build\tomcat-connectors\xdocs\news\20050101.xml
to
C:\build\tomcat-connectors\build\docs\news/20050101.html
[style] Processing C:\build\tomcat-connectors\xdocs\news\20060101.xml
to
C:\build\tomcat-connectors\build\docs\news/20060101.html
[style] Transforming into C:\build\tomcat-connectors\build\docs>
[style] Processing C:\build\tomcat-connectors\xdocs\index.xml
to
C:\build\tomcat-connectors\build\docs\index.html
[style] Loading stylesheet C:\build\tomcat-connectors\xdocs\style.xsl
BUILD SUCCESSFUL
Total time: 10 seconds
C:\build\tomcat-connectors>
</code></pre></div>
</p>
<p>
All the xml files present in the xdocs directory structure were transformed
to html and copied to the <b>GIT_HOME\tomcat-connectors\build\docs</b>
directory. Open one of the
html files in your browser and see how it looks.
</p>
</div></div>
<div class="subsection"><h4 id="STEP_4.___The_editing_process.">STEP 4. The editing process.</h4><div class="text">
<p>
I find it easier to use two windows while doing my updates. One I call my
<b>build</b> window. I keep this one in the <b>GIT_HOME\tomcat-connectors\xdocs</b>
directory and I only run two commands in this window:
<note>First I run</note>
<div class="codeBox"><pre><code>ant clean
</code></pre></div>
<note>Then I run</note>
<div class="codeBox"><pre><code>ant all
</code></pre></div>
</p>
<p>
My second window I call my <b>edit</b> window and I keep that one in the
<b>GIT_HOME\tomcat-connectors\xdocs</b> directory where I'm doing my
edits, diffs and git pulls.
</p>
<p>
Before you start editing you should always update your local repository to
prevent conflicts.
<div class="codeBox"><pre><code>C:\build\tomcat-connectors> git pull
</code></pre></div>
</p>
<p>
Now that your repository is up to date you can begin editing. Find
something in the documentation to edit. When you find something remember the
name of the file. In your <b>edit</b> window find and edit the xml source file
with the same name. After you are done return to the <b>build</b> window, and
in the <b>GIT_HOME\tomcat-connectors\xdocs</b> directory run:
<div class="codeBox"><pre><code>C:\build\tomcat-connectors\xdocs> ant clean
</code></pre></div>
</p>
<p>
This will delete all the previous html files and make the area ready for
updated material. Now to make fresh documents that incorporate your changes
run:
<div class="codeBox"><pre><code>C:\build\tomcat-connectors\xdocs> ant all
</code></pre></div>
</p>
<p>
Use your browser to view the edits you just made, they will be in the
<b>GIT_HOME\tomcat-connectors\build\docs</b> sub-tree. If it looks
good and is ready to go,
all that is left to do is to create a patch and submit it.
</p>
</div></div>
<div class="subsection"><h4 id="STEP_5.__Creating_a_patch_and_submitting_it.">STEP 5. Creating a patch and submitting it.</h4><div class="text">
<p>
From your <b>edit</b> window cd into the directory that contains the xml
file you are working on, and run the <b>git pull</b> command. For example,
to produce a diff of the index.xml file and call it patch.txt, you
would cd into the directory containing the index.xml file and:
<div class="codeBox"><pre><code>C:\build\tomcat-connectors\xdocs\>git diff index.xml >
patch.txt.
</code></pre></div>
</p>
<p>
Now that you have your patch you are ready to send it in.
</p>
<p>
Patches to the documentation are handled just like a bug report. You
should submit your patches to <a href="http://issues.apache.org/bugzilla/">http://issues.apache.org/bugzilla/</a>
and include a good one line subject. If this is your first time to use the
bug database then you should read <a href="http://issues.apache.org/bugzilla/bugwritinghelp.html">http://issues.apach
e.org/bugzilla/bugwritinghelp.html.</a> You will need to create a user
account. At the web site paste your patch into the web form and don't forget
to describe what it is your patch is for. Sooner or later a someone with
commit privileges will review your suggestion.
</p>
</div></div>
</div><h3 id="Updating_Web_site">Updating Web site</h3><div class="text">
<p>
Only Committers are able to update the web site (http://tomcat.apache.org/connectors-doc/).
To do it:
<ul>
<li>Connect to people.apache.org.</li>
<li>umask 002</li>
<li>Copy the changed files to /www/tomcat.apache.org/connectors-doc/.</li>
<li>or use ant from a checkout tomcat/jk/trunk/xdocs repository:<br>
ant -Dbuild.dir=/www/tomcat.apache.org -Ddist.name=connectors-doc
</li>
<li>The changes should sync to tomcat.apache.org within seconds.</li>
</ul>
</p>
</div><h3 id="Guides_and_Resources">Guides and Resources</h3><div class="text">
<p>
A little help to get you started if you need it
</p>
<ul>
<li>
<a href="http://www.xml.org/xml/resources_focus_beginnerguide.shtml">XML
Beginner's Guide</a>
</li>
<li>
<a href="http://issues.apache.org/bugzilla/">Bugzilla</a>
</li>
<li>
<a href="http://issues.apache.org/bugwritinghelp.html">Bugzilla Bug
Writing Guide</a>
</li>
<li>
<a href="http://ant.apache.org/">Ant</a>
</li>
<li>
<a href="https://git-scm.com/">Git Home</a>
</li>
<li>
<a href="https://github.com/apache/tomcat-connectors/tree/main/xdocs">JK Docs repository</a>
</li>
</ul>
</div></div></div></div></div><footer><div id="footer">
Copyright © 1999-2024, The Apache Software Foundation
</div></footer></div></body></html>
|
