Documentation

• Administrator's Guide Installing, configuring and administrating Traffic Server

• SDK Programmer's Guide Developing Traffic Server plug-ins and how the code works

• Doxygen documentation Traffic Server developer documentations (work in progress)

• Frequently Asked Questions A running list of your most common questions

• You can add your own to the Wiki

• Wiki

Legacy documentation

• Administrator's Guide for version 2.0.x

• SDK Programmer's Guide for version 2.0.x

• Traffic Server 管理员指南 (PDF)

How to contribute

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.

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)

svn co http://svn.apache.org/repos/asf/trafficserver/site/trunk/ ats-cms

Developers should use https:// in the checkout.

The site and docs can be found in the subdirectory content/. After editing you can create a patch with:

svn diff > my-docs.patch

Attach this patch to your Jira or your mail to dev@. Patches are always heartily welcomed!

Staging

If you are a developer you can commit such a patch like any other. The changes will become immediately visible on our staging site

Building

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 ats-cms checkout:

svn co https://svn.apache.org/repos/infra/websites/cms

Then, change back to our site, and install the (CPAN) packages necessary to build the site

cd ats-cms
./install-ubuntu.sh

There is also an install-fedora.sh 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.

Finally, after a successful installation, you'll need can build the site with:

./build.sh

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 :)

Publishing

The final step is to get the site from our staging area to live. You can do this by running the publish script in the cms repository - my recommendation is to symlink it:

ln -s ../cms/webgui/publish.pl

Finally, run this script with our project name, and your Apache ID:

./publish.pl trafficserver igalic

That's all folks!