History

ricolin 35047c131f Replace github with openstack git repo git.openstack.org is our official server, github is just a read-only mirror. Linking to github might also raise the expectation that we use the usual github workflow which is not the case. Change-Id: I3b3e8213c264757838c8e5fd33221eebf219cdc8		2015-10-21 09:51:40 +08:00
..
api-ref	Replace github with openstack git repo	2015-10-21 09:51:40 +08:00
heat-admin	update pom.xml files with clouddocs-maven-plugin version 1.12.2	2014-01-10 13:02:32 -06:00
README.rst	changed heat dev docs to comply with conventions	2015-04-24 22:03:07 -04:00

Building the user and admin docs

This documentation should eventually end up in the OpenStack documentation repositories api-site and openstack-manuals.

Dependencies

on Ubuntu:

sudo apt-get install maven

on Fedora Core:

sudo yum install maven

Build the REST API reference manual:

cd api-ref mvn clean generate-sources

Build the heat admin guide:

cd heat-admin mvn clean generate-sources