How to publish docs to cocoon.apache.org

If you want to publish the Cocoon docs you can follow one of those two paths:

use the nightly build on cocoon.zones.apache.org
build the docs at your local machine

Use the nightly build

There is a nightly build (runs at 2am and 2pm UTC) of our docs available at cocoon.zones.apache.org. Login via ssh and use the 'maven' user:

sudo su - maven

Then change to

cd ~/svn-site-generation

There you will find a directory svn-docs. It contains a recent checkout (= part of the nightly docs build) and the result of the docs generation process copied over. If you want to see the docs online, point your browser to http://cocoon.zones.apache.org/nightly-docs/.

Note: There is a second job which builds the docs once a day too. In addition to the first one it adds a couple of reports (Findbugs, SVN reports, etc.). See http://cocoon.zones.apache.org/dev-docs/.

Using

svn st svn-docs

will show you all the differences.

If you want to add all the newly generated docs run

svn st | grep "\?" | awk '{print $2}' | xargs svn add

which will recursivly add all new documents.

Then run

svn ci [path] --no-auth-cache --username [username]

for all the docs that you want to publish.

That's it. When the docs are committed to the SVN, they will be published within the next 60 minutes.

Build the docs locally

Actually it's the same as using the nightly build. The only difference is that you have to build the docs yourself. The How to build the docs locally guide explains how you can do this. Then follow the steps from above.

Errors and Improvements? If you see any errors or potential improvements in this document please help us: View, Edit or comment on the latest development version (registration required).

Apache Cocoon

How to publish docs to cocoon.apache.org

Use the nightly build

Build the docs locally