openstack
/
murano-specs
Code Issues Proposed changes
Murano Design Specifications
152 Commits 1 Branch 0 Tags 2.6 MiB
Python 100%
Go to file
Ghanshyam Mann 637f7d6d37 [community goal] Update contributor documentation 
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Story: #2007236
Task: #38539
Change-Id: I02782a89e55625157fa223428a776bb19b5a77d2
 		2021-05-17 18:07:51 -05:00
doc/source Switch to newer openstackdocstheme version 2020-05-31 19:59:12 +02:00
specs Cleanup py27 support and docs 2020-04-09 12:33:19 +02:00
tests Initial setup of spec project 2014-11-18 22:34:38 +03:00
.gitignore Initial setup of spec project 2014-11-18 22:34:38 +03:00
.gitreview OpenDev Migration Patch 2019-04-19 19:33:56 +00:00
.testr.conf Initial setup of spec project 2014-11-18 22:34:38 +03:00
.zuul.yaml import zuul job settings from project-config 2018-08-23 12:01:21 +00:00
CONTRIBUTING.rst [community goal] Update contributor documentation 2021-05-17 18:07:51 -05:00
LICENSE Initial setup of spec project 2014-11-18 22:34:38 +03:00
README.rst Show team and repo badges on README 2016-11-25 15:53:52 +01:00
requirements.txt Switch to newer openstackdocstheme version 2020-05-31 19:59:12 +02:00
setup.cfg Cleanup py27 support and docs 2020-04-09 12:33:19 +02:00
setup.py Update spec repo config 2017-06-02 13:11:28 +03:00
tox.ini Cleanup py27 support and docs 2020-04-09 12:33:19 +02:00

README.rst

Team and repository tags

image

OpenStack Murano Specifications

This git repository is used to hold approved design specifications for additions to the Murano project. Reviews of the specs are done in gerrit, using a similar workflow to how we review and merge changes to the code itself.

The layout of this repository is:

specs/<release>/

Where there are two sub-directories:

specs/<release>/approved: specifications approved but not yet implemented specs/<release>/implemented: implemented specifications

This directory structure allows you to see what we thought about doing, decided to do, and actually got done. Users interested in functionality in a given release should only refer to the implemented directory.

You can find an example spec in doc/source/specs/template.rst.

Specifications are proposed for a given release by adding them to the specs/<release> directory and posting it for review. The implementation status of a blueprint for a given release can be found by looking at the blueprint in launchpad. Not all approved blueprints will get fully implemented.

Specifications have to be re-proposed for every release. The review may be quick, but even if something was previously approved, it should be re-reviewed to make sure it still makes sense as written.

Prior to the Kilo development cycle this repository was not used for spec reviews. Reviews prior to Juno were completed entirely through Launchpad blueprints:

http://blueprints.launchpad.net/murano

Starting from the Kilo-1 developement milestone Murano performs the pilot of the specs repos approach.

Please note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:

https://wiki.openstack.org/wiki/Blueprints

For more information about working with gerrit, see:

http://docs.openstack.org/infra/manual/developers.html#development-workflow

To validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:

$ tox

After running tox, the documentation will be available for viewing in HTML format in the doc/build/ directory.