OpenStack Compute (Nova) Specifications
Go to file
Joe Gordon 58b5738abd Support having different templates for different releases
We want to adjust the template for Kilo, so rename template.rst to
$release-template.rst and update the tests.

Change-Id: Ia65bc72c14f51ff7fbf54af1ef69e9f37c9d58a9
2014-09-30 11:36:16 -07:00
doc/source Merge "Add RSS feed" 2014-09-17 03:41:21 +00:00
specs Support having different templates for different releases 2014-09-30 11:36:16 -07:00
tests Support having different templates for different releases 2014-09-30 11:36:16 -07:00
.gitignore Add .testrepository to gitignore 2014-04-04 19:07:21 +02: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 Add readme to docs 2014-08-07 13:30:10 -07:00
requirements.txt Add RSS feed 2014-09-10 16:01:35 -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 Relax min tox from 1.6 to 1.4 2014-06-03 15:04:29 +01:00

README.rst

README

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 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

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

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.