openstack
/
barbican-specs
Code Issues Proposed changes
Blueprints for the barbican project
42 Commits 1 Branch 0 Tags 2.8 MiB
Python 100%
Go to file
Steve Martinelli 7613e0c9b9 Update doc theme for barbican-specs 
Update the theme used in the barbican-specs documentation to the
latest from oslosphinx. This will help create a more common look
and feel throughout specs.openstack.org.

Change-Id: I29157520915b0952ec650dcfc389667ceaf9b88a
 		2014-08-22 10:50:11 -04:00
doc/source Update doc theme for barbican-specs 2014-08-22 10:50:11 -04:00
specs Merge "Update spec to describe how CADF audit should be supported across keystone and barbican." 2014-08-07 03:54:49 +00:00
.gitignore Initial commit 2014-05-15 10:54:58 -07:00
.gitreview gitreview 2014-06-03 15:10:06 -05:00
LICENSE Add License and README 2014-05-15 14:02:39 -04:00
README.rst Add License and README 2014-05-15 14:02:39 -04:00
requirements.txt Update doc theme for barbican-specs 2014-08-22 10:50:11 -04:00
setup.cfg Remove leftover references to Nova 2014-07-31 16:54:09 -05:00
setup.py First Pass at Doc Build 2014-05-19 20:56:54 -05:00
tox.ini remove py27 2014-06-04 12:03:47 -05:00

README.rst

OpenStack Barbican Specifications

This git repository is used to hold approved design specifications for additions to the Barbican 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 specs/template.rst.

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/barbican

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:

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.