openstack
/
neutron-specs
Code Issues Proposed changes
OpenStack Networking (Neutron) Specifications
640 Commits 1 Branch 0 Tags 28 MiB
Python 100%
Go to file
Cao Xuan Hoang 28f2a4357b Queens: Assessment for neutron-vpnaas 
This patch is following up from Pike discussion [1]. With the remaining
main gap (N4) has been addressed to be able to jump into the stadium.

[1] Ie06395533211847d741c9c9bbd45bc8edbab6e5c

Change-Id: I6a8b19c8c53f49a95667af331e147b977a9d0d7c
Co-Authored-By: Armando Migliaccio <armamig@gmail.com>
 		2017-11-27 08:49:07 +07:00
doc/source Open stadium doc structure 2017-09-21 13:42:45 +07: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 Queens: Assessment for neutron-vpnaas 2017-11-27 08:49:07 +07:00
tests Add Stadium project scorecard 2016-10-13 16:06:30 -07: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 Show team and repo badges on README 2016-11-25 15:37:16 +01:00
requirements.txt Fix docs by limiting sphinx requirement to <1.6.1 2017-06-01 11:16:35 +00:00
setup.cfg Update sphinx to 1.5 2017-03-31 00:20:56 +00:00
setup.py Update sphinx to 1.5 2017-03-31 00:20:56 +00:00
tox.ini Add base neutron-specs framework 2014-04-14 03:08:02 +00: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 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:

http://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.