CloudStack documentation is built using publican. This section describes how to install publican on your own machine so that you can build the documentation guides.
The CloudStack documentation source code is located under /docs
Publican documentation itself is also very
useful.
On RHEL and RHEL derivatives, install publican with the following command:
yum install publican publican-doc
On Ubuntu, install publican with the following command:
apt-get install publican publican-doc
For other distribution refer to the publican documentation listed above. For latest versions of OSX you may have to install from
source and tweak it to your own setup.
Once publican is installed, you need to setup the so-called CloudStack brand defined in the docs/publican-CloudStack directory.
To do so, enter the following commands:
sudo cp -R publican-cloudstack /usr/share/publican/Common_Content/cloudstack
If this fails or you later face errors related to the brand files, see the publican
documentation.
With publican installed and the CloudStack brand files in place, you should be able to build any documentation guide.
