Update information in README
* Add CONTRIBUTING.rst file was added to provide information for new contributors. * Add HACKING.rst Change-Id: Ida2d1dafeb36d54d0721a86fc6962cc220ea2851
This commit is contained in:
Ekaterina Chernova
parent
755e57c2c2
commit
ed04b140c0
|
|
@ -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
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
Murano Dashboard Style Commandments
|
||||
===================================
|
||||
|
||||
*- Step 1: Read the OpenStack Style Commandments
|
||||
http://docs.openstack.org/developer/hacking/
|
||||
|
||||
* Step 2: Read [hacking] section in tox.ini to find the list of names which
|
||||
can be imported directly without triggering the "H302: import only modules"
|
||||
flake8 warning
|
||||
|
||||
* Step 3: Read on
|
||||
39
README.rst
39
README.rst
|
|
@ -1,43 +1,28 @@
|
|||
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.
|
||||
applications in a browsable categorised catalog. Cloud users
|
||||
— including inexperienced ones — can then use the catalog to
|
||||
compose reliable application environments with the push of a button.
|
||||
|
||||
murano-dashboard
|
||||
Murano Dashboard
|
||||
----------------
|
||||
murano-dashboard is an extension for OpenStack Dashboard that provides UI for
|
||||
Murano Dashboard an extension for OpenStack Dashboard that provides UI for
|
||||
Murano. With murano-dashboard user is able to easily manage and control
|
||||
application catalog, running applications and created environments alongside
|
||||
with all other OpenStack resources.
|
||||
|
||||
For developer purpose, please place OpenStack Dashboard extension file, located
|
||||
at *local/_50_murano.py* under horizon/openstack_dashboard/local/enabled
|
||||
directory and run horizon as usually.
|
||||
directory and run horizon as usual.
|
||||
|
||||
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.
|
||||
* `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>`_
|
||||
* `Documentation <http://murano.readthedocs.org/>`_
|
||||
|
|
|
|||
Loading…
Reference in New Issue