Go to file

Serg Melikyan baa23949da Resolve documentation issues

Fix comments that was not fixed in original
change: I5987a5b8abd2db65b64e11a80a5cf08a72c236c4

Change-Id: I0663fecd39526ab0d9e8495aef08b27a968e5736
Closes-bug: #1268537

2014-02-04 17:15:56 +04:00

src

Resolve documentation issues

2014-02-04 17:15:56 +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

README.rst

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.