x/group-based-policy-specs
Code Issues Proposed changes
Group Based Policy Design Specifications
51 Commits 1 Branch 0 Tags 986 KiB
reStructuredText 98.7%
Python 1.3%
76648b3c4b
Go to file
Hemanth Ravi 76648b3c4b Network Function Plugin Framework for GBP 
Framework for lifecycle management of network
services in GBP.

Change-Id: I8e6045c50207f6c3cbf204664c3a4c2f574519ca
Defines: blueprint gbp-network-services-framework
2016-04-19 22:42:44 -07:00
doc/source Prepare repo for Mitaka specs 2016-02-02 17:12:22 +00:00
specs Network Function Plugin Framework for GBP 2016-04-19 22:42:44 -07: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 Update .gitreview for new namespace 2015-10-17 22:29:52 +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.