x/group-based-policy-specs
Code Issues Proposed changes
Group Based Policy Design Specifications
32 Commits 1 Branch 0 Tags 986 KiB
reStructuredText 98.7%
Python 1.3%
de694f7164
Go to file
Igor Duarte Cardoso de694f7164 tox doesn't fail anymore at the py27 environment 
This patch fixes existing specs to totally conform to tox py27 environment
tests as specified by tests/test_titles.py. Semantic information of all
existing specs has not been changed.

Specifically, this patch makes the following changes:
* Fixes all titles and subtitles' capitalization inconsistencies:
  defaulting to only having the first word being capitalized (this seems
  to be the general rule in group-based-policy-specs);
* Adds missing titles and subtitles to some specs;
* Changes tests/test_titles.py for consistency: only 1st word capitalized;
* Changes tests/tests_titles.py: subtitle count inside Testing or
  Documentation impact no longer restricted to 0.

Change-Id: I88e30b0825f5279a8c6808fd9a2fc2987b6611f9
Closes-Bug: #1437282
2015-04-15 10:44:25 +01:00
doc/source Adding kilo branch 2015-01-29 20:52:45 -05:00
specs tox doesn't fail anymore at the py27 environment 2015-04-15 10:44:25 +01: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 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 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.