OpenStack Networking (Neutron) Specifications
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
YAMAMOTO Takashi 2c6f12f375
template.rst: Fix build failure
8 years ago
doc/source Add Kilo priorities for Neutron 8 years ago
priorities Add Kilo priorities for Neutron 8 years ago
specs template.rst: Fix build failure 8 years ago
tests Add an "IPv6 Impact" section to the template 8 years ago
.gitignore Changed .gitignore file to ignore .idea (Pycharm) and *~ (emacs) 9 years ago
.gitreview Added .gitreview 9 years ago
.testr.conf Add base neutron-specs framework 9 years ago
LICENSE Add base neutron-specs framework 9 years ago
README.rst Fix a typo. 9 years ago
requirements.txt Merge "Remove docutils pin" 8 years ago
setup.cfg Add base neutron-specs framework 9 years ago
setup.py Add base neutron-specs framework 9 years ago
tox.ini Add base neutron-specs framework 9 years ago

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.