OpenStack Networking (Neutron) Specifications
Go to file
Slawek Kaplonski c886130f15 Switch to stestr
According to Openstack summit session [1] stestr is
maintained project to which all Openstack projects
should migrate.
Let's switch it then.

[1] https://etherpad.openstack.org/p/YVR-python-pti

Change-Id: Idd7629f2a051aadaf53b04a1b331b20d7fa690de
2018-06-22 12:50:11 +02:00
doc Delete redundant rst files and update README 2018-04-11 15:24:45 +09:00
images Introduce address scopes 2015-06-10 11:54:40 -06:00
misc Removed networking_general_api_information.rst 2016-08-27 21:07:47 +00:00
specs Merge "(Operator-only) Extend logging framework for FWaaS v2" 2018-05-30 17:43:18 +00:00
tests Fix py27 job in specs repo 2018-05-30 10:28:57 +02:00
.gitignore Switch to stestr 2018-06-22 12:50:11 +02:00
.gitreview Added .gitreview 2014-03-28 19:24:51 +00:00
.stestr.conf Switch to stestr 2018-06-22 12:50:11 +02:00
LICENSE Add base neutron-specs framework 2014-04-14 03:08:02 +00:00
README.rst Delete redundant rst files and update README 2018-04-11 15:24:45 +09:00
requirements.txt Switch to stestr 2018-06-22 12:50:11 +02:00
setup.cfg Need to follow the new PTI for document build 2018-02-28 23:58:22 +09:00
setup.py Update sphinx to 1.5 2017-03-31 00:20:56 +00:00
tox.ini Switch to stestr 2018-06-22 12:50:11 +02:00

README.rst

Team and repository tags

image

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

https://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://docs.openstack.org/infra/manual/developers.html#development-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.