stackforge-attic/murano-docs
Code Issues Proposed changes
561 Commits 5 Branches 13 Tags 11 MiB
CSS 61.6%
XSLT 38.4%
766b267013
Go to file
Serg Melikyan 766b267013 Update README with actual info 
Change-Id: Ic0459370b87c04450d468f51f7248e5ae71d7864
2014-02-21 00:05:20 +04:00
src Fix errors in documentation 2014-02-11 10:52:22 +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 Update README with actual info 2014-02-21 00:05:20 +04:00

README.rst

Murano

Murano Project introduces an application catalog, which allows application developers and cloud administrators to publish various cloud-ready applications in a browsable‎ categorised catalog, which may be used by the cloud users (including the inexperienced ones) to pick-up the needed applications and services and composes the reliable environments out of them in a “push-the-button” manner.

murano-docs

murano-docs repository contains different guides, manuals and documentation for Murano project. Guides:

  • Administrators Guide
  • Developers Guide
  • Getting Started Guide
  • User Guide

Please, refer to How to Build sections for details about how to build guides located in this repository.

Project Resources

How To Participate

If you would like to ask some questions or make proposals, feel free to reach us on #murano IRC channel at FreeNode. Typically somebody from our team will be online at IRC from 6:00 to 20:00 UTC. You can also contact Murano community directly by openstack-dev@lists.openstack.org adding [Murano] to a subject.

We’re holding public weekly meetings on Tuesdays at 17:00 UTC on #openstack-meeting-alt IRC channel at FreeNode.

If you want to contribute either to docs or to code, simply send us change request via gerrit. You can file bugs and register blueprints on Launchpad.

How to Build

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

Build

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