Versions Compared

Key

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

...

This page is a supplement to the main release procedure. The release manager may or may not also be the docs release manager. Note that this is a rough draft at the moment based on one release.

Prerequisites to Building and Publishing Documentation

...

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

Suggestion: have a src directory under your $HOME directory and make a web or svn directory for the SVN tree.

You should have two source code directories: the Apache CloudStack source and the source for the Apache CloudStack Web site.

...

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.

Note that you'll need to edit the acsdocs.cfg file to match your environment. Again, replace the variable (filename) after --config= to the appropriate value, like publican-install.cfg, etc. All of the appropriate config files are under the cloudstack/docs directory, just do 'ls *cfg' and you'll see all of them. Note that some of them are unusued.

...