Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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:

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

...

Note that both the SVN tree and Git tree are "cloudstack" so you probably don't want to check out the SVN tree in the same directory as the CloudStack directory. (Plus I don't think SVN would let you do that anyway.)

...

Use Publican to build the docs:

No Format
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.

...

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.

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

Here ~/src/web/cloudstack/docsite/ is under the SVN tree in my environment. You'll need to sanity check the path for your own environment.

...

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

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