Status
colour Yellow title outdated

See Release Procedure for a more up to date version on how the docs can be uploaded

Releasing Publican Documentation from Apache CloudStack

...

You'll also need a checkout of the Web site via SVN. If you don't have this already, you'll need to get it, like so:

svn co https://svn.apache.org/repos/asf/cloudstack/

...

Use Publican to build the docs:

publican build --embedtoc --formats=html,epub,pdf,html-single --langs=en-US --publish --config=publican-adminguide.cfg

Replace the .cfg filename in "--config=" with the appropriate configuration file. We currently have four guides that need to be built with each release.

Note that you need to clean out the doc/tmp directory after each guide is built.

Replace the --langs= with the appropriate language(s) that should be built.

...

Next you're going to add the current version of the documentation to the existing documentation. You'll stage this in the docsite directory, and then copy it over to the source tree where the site documentation actually lives.

publican install_book --site_config ~/src/web/cloudstack/docsite/acsdocs.cfg --config=publican-adminguide.cfg --lang en-US

...

Next you'll need to copy the documentation from the docsite directory to the docs directory:

cp -R docsite/html/docs/* site/trunk/content/docs/.

...

Once you've copied over the docs, move to the top-level directory for your SVN tree (like {~/src/web/cloudstack}) and run:

svn status

If everything looks good, then go ahead and commit:

svn ci -m "Committing documentation to the Web site for X.X.X release."

...

If all's well there, then you can commit the documentation:

curl -sL http://s.apache.org/cms-cli | perl

...