openstack
/
neutron-specs
Code Issues Proposed changes
OpenStack Networking (Neutron) Specifications
4 Commits 1 Branch 0 Tags 28 MiB
Python 100%
Go to file
Carl Baldwin d76bec4015 Allow adding sub-headings under Proposed change header 
This changes the titles test under the "Proposed change" heading so
that it checks that *at least* the required 9 headings exist instead
of checking that *exactly* the required 9 headings exist.

This will allow writers like me to add some structure to the first
section under this heading before getting to the required sections.

Change-Id: I507d32cb2568d9c65b7a460196fdd873c4c5c445
 		2014-04-17 12:16:10 -06:00
doc/source Add base neutron-specs framework 2014-04-14 03:08:02 +00:00
specs Note the usage of asciiflow.com for diagrams 2014-04-15 01:20:49 +00:00
tests Allow adding sub-headings under Proposed change header 2014-04-17 12:16:10 -06:00
.gitignore Add base neutron-specs framework 2014-04-14 03:08:02 +00:00
.gitreview Added .gitreview 2014-03-28 19:24:51 +00:00
.testr.conf Add base neutron-specs framework 2014-04-14 03:08:02 +00:00
LICENSE Add base neutron-specs framework 2014-04-14 03:08:02 +00:00
README.rst Add base neutron-specs framework 2014-04-14 03:08:02 +00:00
requirements.txt Add base neutron-specs framework 2014-04-14 03:08:02 +00:00
setup.cfg Add base neutron-specs framework 2014-04-14 03:08:02 +00:00
setup.py Add base neutron-specs framework 2014-04-14 03:08:02 +00:00
tox.ini Add base neutron-specs framework 2014-04-14 03:08:02 +00:00

README.rst

OpenStack Neutron Specifications

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

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. Please do not checkin the generated HTML files as a part of your commit.