Add information to Readme

* change readme file to rst format
* update information regarding application packages
* add CONTRIBUTING.rst file

Change-Id: Id9f711a8a94cb5e4e6d605b97b3886770d26f968
This commit is contained in:
Ekaterina Chernova 2015-04-23 15:34:23 +03:00
parent dee685beab
commit f05f4175e8
4 changed files with 95 additions and 4 deletions

51
CONTRIBUTING.rst Normal file
View File

@ -0,0 +1,51 @@
======================
Contributing to Murano
======================
If you're interested in contributing to the Murano project,
the following will help get you started.
Contributor License Agreement
=============================
In order to contribute to the Murano project, you need to have
signed OpenStack's contributor's agreement:
* http://docs.openstack.org/infra/manual/developers.html
* http://wiki.openstack.org/CLA
Project Hosting Details
=======================
* Bug tracker
* https://launchpad.net/murano
* https://launchpad.net/python-muranoclient
* Mailing list (prefix subjects with ``[Murano]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
* Wiki
https://wiki.openstack.org/wiki/Murano
* IRC channel
* #murano at FreeNode
* https://wiki.openstack.org/wiki/Meetings#Murano_meeting
* Code Hosting
* https://git.openstack.org/cgit/openstack/murano
* https://git.openstack.org/cgit/openstack/murano-agent
* https://git.openstack.org/cgit/openstack/murano-dashboard
* https://git.openstack.org/cgit/openstack/python-muranoclient
* https://git.openstack.org/cgit/openstack/murano-apps
* Code Review
* https://review.openstack.org/#/q/murano+AND+status:+open,n,z
* http://docs.openstack.org/infra/manual/developers.html#development-workflow

4
HACKING.rst Normal file
View File

@ -0,0 +1,4 @@
Style Commandments
==================
Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/

40
README.rst Normal file
View File

@ -0,0 +1,40 @@
==============================
Murano Applications Repository
==============================
Contains Murano Application packages source code.
All current applications supposed to work on Ubuntu Trusty with murano-agent installed.
Other Ubuntu versions are not tested.
Composing an application package
--------------------------------
Murano Applications are imported as zip archives, so
to make an application ready to use in Murano, it should be zipped first.
To make a valid murano package take *package* folder located under
application directory and zip it's content. Make sure new archive
doesn't contain *package* folder itself. For more information, refer to
`Murano documentation <http://murano.readthedocs.org/>`_.
Importing application package
-----------------------------
* Use murano dashboard to import packages.
Go to *Murano > Manage > Package Definitions*
and press *Import Package*
* Use murano CLI ``murano package-import``
* Local zip file, URL or package name, located in Murano repository can be provided
Building DIB elements for application image
-------------------------------------------
Please, refer to *readme.rst* file located at application
folder to find out how to build image for a specific application.
DIB elements with which image should be build are located at *elements* folder
at the same level with *package* folder.
If application folder doesn't contain *elements* inside - it means,
that no other preparation except murano-agent is needed.

View File

@ -1,4 +0,0 @@
murano-apps
===========
Repository for Murano applications