svn commit: r800666 - /websites/staging/trafficserver/trunk/content/docs/index.en.html

[bu...@apache.org]

Author: buildbot
Date: Tue Dec 20 18:51:30 2011
New Revision: 800666

Log:
Staging update by buildbot

Modified:
    websites/staging/trafficserver/trunk/content/docs/index.en.html

Modified: websites/staging/trafficserver/trunk/content/docs/index.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/index.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/index.en.html Tue Dec 20 18:51:30 2011
@@ -83,6 +83,68 @@ A running list of your most common quest
 <p><a href="../docs/v2/sdk/">SDK Programmer's Guide for version 2.0.x</a></p>
 </li>
 </ul>
+<hr />
+<h1 id="HowContribute">How to contribute</h1>
+<p>If you have noticed a terrible flaw, a typo, or just find something missing or
+lacking in our docs - there's an easy way to fix it. Send us a patch.
+We highly welcome patches of any kind - and those to the docs are not different
+from those to the code.</p>
+<p>To create such a patch you'll have to checkout the "code" from our Subversion
+repository: (n.b.: The site sub-repository is not mirrored in Git)</p>
+<div class="codehilite"><pre>svn co http://svn.apache.org/repos/asf/trafficserver/site/trunk/ ats-site
+</pre></div>
+
+
+<p>Developers should use <code>https://</code> in the checkout.</p>
+<p>The site and docs can be found in the subdirectory <code>content/</code>. After editing
+you can create a patch with:</p>
+<div class="codehilite"><pre>svn diff &gt; my-docs.patch
+</pre></div>
+
+
+<p>Attach this patch to your <a href="https://issues.apache.org/jira/browse/TS">Jira</a> or your
+mail to <a href="mailto:dev@trafficserver.apache.org?subject=[PATCH] fix to docs or site">dev@</a>.
+Patches are always heartly welcomed!</p>
+<h1 id="Staging">Staging</h1>
+<p>If you are a developer a developer you can commit such a patch like any other.
+The changes will become immediately visible on our <a href="http://trafficserver.staging.apache.org/">staging site</a></p>
+<h1 id="Building">Building</h1>
+<p>If you would like to verify how a change will look before committing, you can
+build it yourself. For this purpose, you will have to checkout the build tools.
+You should do this outside of the above <code>ats-site</code> checkout:</p>
+<div class="codehilite"><pre>svn co https://svn.apache.org/repos/infra/websites/cms
+</pre></div>
+
+
+<p>Then, change back to our site, and install the (CPAN) packages necessary to build the site</p>
+<div class="codehilite"><pre>cd ats-site
+./install-ubuntu.sh
+</pre></div>
+
+
+<p>There is also an <code>install-fedora.sh</code> script - if you are not on either of those platforms,
+you can at least read the scripts to see which parts need to be installed.</p>
+<p>Finally, after a successful installation, you'll need can build the site with:</p>
+<div class="codehilite"><pre>./build.sh
+</pre></div>
+
+
+<p>This script has been verified to work on Linux and OS X (and by extension should also
+work on FreeBSD). If you find any problems with it, please be so kind as to fix them :)</p>
+<h1 id="Publish">Publishing</h1>
+<p>The final step is to get the site from our <a href="http://trafficserver.staging.apache.org/">staging area</a>
+to <a href="http://trafficserver.apache.org/">live</a>. You can do this by running the publish script
+in the <code>cms</code> repository - my recommendation is to symlink it:</p>
+<div class="codehilite"><pre>ln -s ../cms/webgui/publish.pl
+</pre></div>
+
+
+<p>Finally, run this script with our project name, and <strong>your</strong> Apache ID:</p>
+<div class="codehilite"><pre>./publish.pl trafficserver igalic
+</pre></div>
+
+
+<p>That's all folks!</p>
         </div>
       </div>
       <div class="fourcol last">