Group Based Policy Design Specifications
Go to file
OpenDev Sysadmins b9e720faf4 OpenDev Migration Patch
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
2019-04-19 19:50:49 +00:00
doc/source Fixing the deprecated library function. 2016-05-12 17:39:58 +05:30
specs Dual-stack L3-Policy mapping 2017-05-18 12:13:04 +00:00
tests tox doesn't fail anymore at the py27 environment 2015-04-15 10:44:25 +01:00
.gitignore Adding some missing repo artifacts 2014-10-05 20:40:52 -07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:50:49 +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 Workflow documentation is now in infra-manual 2014-12-05 03:30:45 +00: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:

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.