OpenStack Compute (Nova) Specifications
Go to file
Joe Gordon 037adec4b8 Add unit test to make sure all sections are present
Add a unit test that will check to make sure all top-level headings
and sub-headings are present.

The downside of this test is that it's going to fail on *every* merged
spec if we add or change a heading to the template.

Co-authored-by: Russell Bryant <rbryant@redhat.com>
Change-Id: I1c15282e166fb3fe2e60fcf063a6cd822a3411ff
2014-03-31 12:03:41 -04:00
doc/source Fix a sphinx docs error 2014-03-31 11:55:40 -04:00
specs Merge "Standardize section header capitalization" 2014-03-28 19:14:10 +00:00
tests Add unit test to make sure all sections are present 2014-03-31 12:03:41 -04:00
.gitignore Make nova-specs an oslosphinx project 2014-03-24 16:28:41 -04:00
.gitreview Added .gitreview 2014-03-14 23:09:48 +00:00
.testr.conf Add unit test to make sure all sections are present 2014-03-31 12:03:41 -04:00
LICENSE Switch license to CC-BY 3.0. 2014-03-24 16:28:41 -04:00
README.rst Update README with link to Blueprint wiki 2014-03-27 08:56:10 +00:00
requirements.txt Add unit test to make sure all sections are present 2014-03-31 12:03:41 -04:00
setup.cfg Make sphinxbuild fail on formatting errors 2014-03-31 11:56:45 -04:00
setup.py Make nova-specs an oslosphinx project 2014-03-24 16:28:41 -04:00
tox.ini Add unit test to make sure all sections are present 2014-03-31 12:03:41 -04:00

README.rst

OpenStack Nova Specifications

This git repository is used to hold approved design specifications for additions to the Nova 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>/

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 Juno development cycle, this repository was not used for spec reviews. Reviews prior to Juno were completed entirely through Launchpad blueprints:

http://blueprints.launchpad.net/nova

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:

https://wiki.openstack.org/wiki/Gerrit_Workflow