Update README with actual info
Change-Id: Ic0459370b87c04450d468f51f7248e5ae71d7864
This commit is contained in:
parent
d282158ff2
commit
766b267013
61
README.rst
61
README.rst
@ -1,18 +1,53 @@
|
||||
Murano Manuals
|
||||
+++++++++++++++++
|
||||
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.
|
||||
|
||||
This repository contains documentation for the
|
||||
Murano project. It includes:
|
||||
murano-docs
|
||||
-----------
|
||||
murano-docs repository contains different guides, manuals and documentation for
|
||||
Murano project. Guides:
|
||||
|
||||
* API Specification
|
||||
* Architecture
|
||||
* Installation
|
||||
* Administrators Guide
|
||||
* Developers Guide
|
||||
* Getting Started Guide
|
||||
* User Guide
|
||||
|
||||
For more details, see the `Murano <http://murano-docs.github.io>`_.
|
||||
Please, refer to `How to Build`_ sections for details about how to build guides
|
||||
located in this repository.
|
||||
|
||||
Project Resources
|
||||
-----------------
|
||||
* `Murano at Launchpad <http://launchpad.net/murano>`__
|
||||
* `Wiki <https://wiki.openstack.org/wiki/Murano>`__
|
||||
* `Code Review <https://review.openstack.org/>`__
|
||||
* `Sources <https://wiki.openstack.org/wiki/Murano/SourceCode>`__
|
||||
* `Developers Guide <http://murano-docs.github.io/latest/developers-guide/content/ch02.html>`__
|
||||
|
||||
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 <https://review.openstack.org/>`__.
|
||||
You can `file bugs <https://bugs.launchpad.net/murano/+filebug>`__ and
|
||||
`register blueprints <https://blueprints.launchpad.net/murano/+addspec>`__ on
|
||||
Launchpad.
|
||||
|
||||
How to Build
|
||||
============
|
||||
Prerequisites
|
||||
=============
|
||||
-------------
|
||||
`Apache Maven <http://maven.apache.org/>`_ must be installed to build the
|
||||
documentation.
|
||||
|
||||
@ -25,8 +60,8 @@ On Fedora 15 and later::
|
||||
yum install maven3
|
||||
|
||||
|
||||
Building
|
||||
========
|
||||
Build
|
||||
-----
|
||||
The different manuals are in subdirectories of the
|
||||
``docs/src/`` directory.
|
||||
|
||||
@ -44,7 +79,3 @@ 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.
|
||||
|
Loading…
Reference in New Issue
Block a user