openstack
/
neutron-specs
Code Issues Proposed changes
OpenStack Networking (Neutron) Specifications
244 Commits 1 Branch 0 Tags 28 MiB
Python 100%
Go to file
Kyle Mestery 8a524f54c7 Reformat template.rst. 
Change the layout of this file to move the formatting examples to the bottom
to move clearly highlight the operator requirements section at the top. Also
update the test infrastructure to reflect the changes, and also only run
unit tests on the kilo specs.

Change-Id: Ie5e0c2779e69585c1800d6ecaf9062f3d2d81cbb
 		2014-09-25 13:44:48 +00:00
doc/source Stop using intersphinx 2014-09-13 09:30:17 +02:00
specs Reformat template.rst. 2014-09-25 13:44:48 +00:00
tests Reformat template.rst. 2014-09-25 13:44:48 +00:00
.gitignore Changed .gitignore file to ignore .idea (Pycharm) and *~ (emacs) 2014-07-01 01:33:18 +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 Fix a typo. 2014-08-04 11:45:15 -04:00
requirements.txt Merge "Remove docutils pin" 2014-09-25 19:22:49 +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. A skeleton that contains all the sections required for a spec file is located in doc/source/specs/skeleton.rst and can be copied, then filled in with the details of a new blueprint for convenience.

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 check in the generated HTML files as a part of your commit.