From 766b26701334800b1124546c21bbc41a91f70efb Mon Sep 17 00:00:00 2001 From: Serg Melikyan Date: Fri, 21 Feb 2014 00:05:20 +0400 Subject: [PATCH] Update README with actual info Change-Id: Ic0459370b87c04450d468f51f7248e5ae71d7864 --- README.rst | 61 ++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 46 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 0f7bb7e..5c98fe3 100644 --- a/README.rst +++ b/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 `_. +Please, refer to `How to Build`_ sections for details about how to build guides +located in this repository. +Project Resources +----------------- +* `Murano at Launchpad `__ +* `Wiki `__ +* `Code Review `__ +* `Sources `__ +* `Developers Guide `__ +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. @@ -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.