47ea20b8ea
With the incorporation of many projects within OpenStack, it's very important to use standards in the documentation This is important for formalization as well as consistency the proper usage is: heat or Orchestration or Orchestration module heat should not be capitalized https://wiki.openstack.org/wiki/Documentation/Conventions Change-Id: Ia8d7f1429f877e4c88fc9b210948b63443376ba0
32 lines
514 B
ReStructuredText
32 lines
514 B
ReStructuredText
================================
|
|
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
|
|
|
|
Use `mvn`
|
|
=========
|
|
|
|
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
|
|
|