stackforge-attic/murano-docs
Code Issues Proposed changes
4cb3f3de6c
murano-docs/README.rst
Timur Sufiev cae29398c8 Cherry-pick changes from release-0.2. 
* Prepare documentation for a release-0.2
  Update git clone information, rename murano-manual to
  developers-guide, update known issues
  I90423126b5e4a49ef424fcf63373de5472804235
* Add user-guide draft. Exclude screenshots
  I1d5fa671b8a2eefcc4887ec177702c9e04ef8584
* Fix last typos and remarks in developers guide
  Also User guide was filled in with screenshots and updated
  with new information.
  I5e2592087c142202fe03db2123d0fe91dd9669de
* Murano Deployment Guide renamed and updated.
  Ia7b14e7dc79c2721901d3a1a5c53c9334335c12a
* Fix incorrent sentence
  Ib781c3ca247b91aebf5031e4ec8997e8277c6574
* Alpha version of murano user guide
  I88c8ad45e6f4a7a3d8c0f42579dba252c479372d
* Add forgetten images
  I5aba9d88ad70b100e45a6a0c278054b93dc4f1bf
* Developers Guide pom.xml was accidentally deleted
  I6e966105711394d0fe9426ac78e68c4dea8d728f
* Add getting-started guide
  Also changed:
  1) User guide updated: table with service description
  for AD was added
  2) Add information for configuration OPENSTACK_HOST
  in installation guide
  3) Some style for this documents was added
  Iaff2b841990e10e8c2cfd657a01ca76514491f10

Change-Id: Ic0ac44675999aca3e872c1762e4a1d7f1553f5f2
2013-09-11 12:22:55 +04:00

1.1 KiB
Raw Blame History

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.