openstack
/
murano-specs
Code Issues Proposed changes
Murano Design Specifications
141 Commits 1 Branch 0 Tags 2.6 MiB
Python 100%
Go to file
Doug Hellmann 8eda2a0047 fix tox python3 overrides 
We want to default to running all tox environments under python 3, so
set the basepython value in each environment.

We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.

We do not want to set the override once in testenv, because that
breaks the more specific versions used in default environments like
py35 and py36.

Change-Id: Id58d48b4d42bd4bef006d866942bd01b945dca71
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
 		2018-09-26 18:57:20 -04:00
doc/source Update spec repo config 2017-06-02 13:11:28 +03:00
specs Trivial: updat pypi url to new url 2018-05-13 21:18:52 +08: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 Update .gitreview file to reflect repo rename 2015-04-18 00:37:36 +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
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 Update spec repo config 2017-06-02 13:11:28 +03:00
setup.cfg Update spec repo config 2017-06-02 13:11:28 +03:00
setup.py Update spec repo config 2017-06-02 13:11:28 +03:00
tox.ini fix tox python3 overrides 2018-09-26 18:57:20 -04: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.