Group Based Policy Design Specifications

Go to file

Jenkins 4c6f215d88 Merge "Specification for GBP driver for Nuage networks"		2014-11-25 23:20:21 +00:00
doc/source	Adding some missing repo artifacts	2014-10-05 20:40:52 -07:00
specs	Merge "Specification for GBP driver for Nuage networks"	2014-11-25 23:20:21 +00:00
tests	Initial commit with GBP spec and repo artifacts	2014-09-23 08:55:07 -07:00
.gitignore	Adding some missing repo artifacts	2014-10-05 20:40:52 -07:00
.gitreview	Added .gitreview	2014-09-08 16:51:41 +00:00
.testr.conf	Adding some missing repo artifacts	2014-10-05 20:40:52 -07:00
LICENSE	Initial commit with GBP spec and repo artifacts	2014-09-23 08:55:07 -07:00
README.rst	Initial commit with GBP spec and repo artifacts	2014-09-23 08:55:07 -07:00
requirements.txt	Adding some missing repo artifacts	2014-10-05 20:40:52 -07:00
setup.cfg	Initial commit with GBP spec and repo artifacts	2014-09-23 08:55:07 -07:00
setup.py	Initial commit with GBP spec and repo artifacts	2014-09-23 08:55:07 -07:00
tox.ini	Initial commit with GBP spec and repo artifacts	2014-09-23 08:55:07 -07:00

README.rst

Group Based Policy Specifications

This git repository is used to hold approved design specifications for additions to the Group Based Policy 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.

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.