Author: igalic
Date: Tue Dec 20 18:51:16 2011
New Revision: 1221429
URL: http://svn.apache.org/viewvc?rev=1221429&view=rev
Log:
Update documentation on documentation.
install-ubuntu.sh now also installs the packages required to publish
install-fedora.sh needs an update in this regard
Modified:
trafficserver/site/trunk/ (props changed)
trafficserver/site/trunk/content/docs/index.en.mdtext
trafficserver/site/trunk/install-ubuntu.sh
Propchange: trafficserver/site/trunk/
------------------------------------------------------------------------------
--- svn:externals (added)
+++ svn:externals Tue Dec 20 18:51:16 2011
@@ -0,0 +1 @@
+https://svn.apache.org/repos/infra/websites/cms/webgui/publish.pl publish.pl
Propchange: trafficserver/site/trunk/
------------------------------------------------------------------------------
--- svn:ignore (added)
+++ svn:ignore Tue Dec 20 18:51:16 2011
@@ -0,0 +1 @@
+publish.pl
Modified: trafficserver/site/trunk/content/docs/index.en.mdtext
URL:
http://svn.apache.org/viewvc/trafficserver/site/trunk/content/docs/index.en.mdtext?rev=1221429&r1=1221428&r2=1221429&view=diff
==============================================================================
--- trafficserver/site/trunk/content/docs/index.en.mdtext (original)
+++ trafficserver/site/trunk/content/docs/index.en.mdtext Tue Dec 20 18:51:16
2011
@@ -42,3 +42,76 @@ A running list of your most common quest
* [SDK Programmer's Guide for version 2.0.x](../docs/v2/sdk/)
+---
+
+# How to contribute # {#HowContribute}
+
+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)
+
+ :::text
+ svn co http://svn.apache.org/repos/asf/trafficserver/site/trunk/ ats-site
+
+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:
+
+ :::text
+ svn diff > my-docs.patch
+
+Attach this patch to your [Jira](https://issues.apache.org/jira/browse/TS) or
your
+mail to [dev@](mailto:[email protected]?subject=[PATCH] fix to
docs or site).
+Patches are always heartly welcomed!
+
+# Staging # {#Staging}
+
+If you are a developer a developer you can commit such a patch like any other.
+The changes will become immediately visible on our [staging
site](http://trafficserver.staging.apache.org/)
+
+# Building # {#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-site` checkout:
+
+ :::text
+ 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
+
+ ::::text
+ cd ats-site
+ ./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:
+
+ :::text
+ ./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 # {#Publish}
+
+The final step is to get the site from our [staging
area](http://trafficserver.staging.apache.org/)
+to [live](http://trafficserver.apache.org/). You can do this by running the
publish script
+in the `cms` repository - my recommendation is to symlink it:
+
+ :::text
+ ln -s ../cms/webgui/publish.pl
+
+Finally, run this script with our project name, and **your** Apache ID:
+
+ :::text
+ ./publish.pl trafficserver igalic
+
+That's all folks!
Modified: trafficserver/site/trunk/install-ubuntu.sh
URL:
http://svn.apache.org/viewvc/trafficserver/site/trunk/install-ubuntu.sh?rev=1221429&r1=1221428&r2=1221429&view=diff
==============================================================================
--- trafficserver/site/trunk/install-ubuntu.sh (original)
+++ trafficserver/site/trunk/install-ubuntu.sh Tue Dec 20 18:51:16 2011
@@ -16,7 +16,7 @@
# specific language governing permissions and limitations
# under the License.
-sudo apt-get install python-markdown libsoap-lite-perl libxml-atom-perl
libsvn-perl
+sudo apt-get install python-markdown libsoap-lite-perl libxml-atom-perl
libsvn-perl libjson-xs-perl
( cd /usr/local/bin &&
sudo ln -s /usr/bin/markdown_py markdown )
