Go to file
Dmitry Teselkin 4cb3f3de6c Cherry-pick from the release-0.4 branch
* Fix issues in admin guide

   comments mentioned in https://review.openstack.org/#/c/65926/
   document style (XML style, formatting issues)

   Closes-Bug: 1268537

* Resolve documentation issues

   Fix comments that was not fixed in original
   Closes-bug: #1268537

* Update documentation for a release-0.4.1 release

   Closes-bug: #1268537

Change-Id: I5bf3f01500dc4023e5477e5173d4f6a9922bd034
2014-02-10 17:35:38 +04:00
src Cherry-pick from the release-0.4 branch 2014-02-10 17:35:38 +04:00
.gitignore Restructured manual 2013-07-29 16:23:35 +04:00
.gitreview Adding .gireview file 2013-05-15 12:01:37 +04:00
LICENSE Removed all projects except Glazier Docs 2013-04-09 15:00:23 +04:00
README.rst Cherry-pick changes from release-0.2. 2013-09-11 12:22:55 +04:00

Murano Manuals

This repository contains documentation for the Murano project. It includes:

  • API Specification
  • Architecture
  • Installation

For more details, see the Murano.

Prerequisites

Apache Maven must be installed to build the documentation.

To install Maven 3 for Ubuntu 12.04 and later,and Debian wheezy and later:

apt-get install maven

On Fedora 15 and later:

yum install maven3

Building

The different manuals are in subdirectories of the docs/src/ directory.

To build a specific guide, look for a pom.xml file within a subdirectory, then run the mvn command in that directory. For example:

cd docs/src/developers-guide
mvn clean generate-sources

The generated PDF documentation file is:

docs/src/developers-guide/src/target/docbkx/pdf/developers-guide.pdf

The root of the generated HTML documentation is:

docs/src/developers-guide/src/target/docbkx/webhelp/developers-guide/content/index.html

Installing

Refer to http://murano.openstack.org Learn more about the Murano project.