Blueprints for the barbican project
Go to file
Flavio Percoco 24ddee8937 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

https://gist.github.com/25ec3803cb84c530b5d0bf7f44d01077

Change-Id: I47804903a4dbeebe69f406e1cef0709e91e30d00
2016-11-25 16:46:22 +01:00
doc/source Blueprint for Deployer Secret Metadata 2016-05-03 15:18:35 +00:00
specs Adding spec for supporting multiple secret store backends 2016-08-22 17:05:31 -07:00
.gitignore Fix the sphinx build path in .gitignore file 2015-09-22 22:39:36 +05:30
.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 Show team and repo badges on README 2016-11-25 16:46:22 +01:00
requirements.txt Add RSS feed 2014-09-10 15:56:50 -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

Team and repository tags

image

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:

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.