Go to file
Arnaud Legendre 2ebcb01820 Add a README paragraph with the tox -e docs cmd
People not familiar with the nova-specs system might
get confused when getting Jenkins failures for their
specification.
It's worth providing the test command in the README file to
allow people to fix these issues before submitting the
patch to Gerrit.

Change-Id: I13954599b057790ab5ae7c83493c3193acf8dc22
2014-04-01 17:04:53 -07:00
2014-04-01 14:03:03 -03:00
2014-03-14 23:09:48 +00:00
2014-03-24 16:28:41 -04:00
2014-03-24 16:28:41 -04:00

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

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

$ tox
Description
OpenStack Compute (Nova) Specifications
Readme 61 MiB
Languages
Python 90.3%
Shell 9.7%