Blueprints for the barbican project
Go to file
Grzegorz Grasza 33b30e604c Update the secret consumers spec
This changes the spec, so that the API makes the same assumptions
as the container consumers API.

Change-Id: I02f6dfc072416780dc541534733274279a849423
2022-09-09 14:12:07 +02:00
doc/source remove unicode from code 2021-01-05 17:13:21 +08:00
specs Update the secret consumers spec 2022-09-09 14:12:07 +02:00
.gitignore Ignore some files during running tox 2017-06-15 10:31:42 +07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:34:04 +00:00
.zuul.yaml import zuul job settings from project-config 2018-09-08 19:28:25 +02:00
LICENSE Add License and README 2014-05-15 14:02:39 -04:00
README.rst Update README and specs/template.rst 2019-05-24 10:32:10 -05:00
requirements.txt Switch to newer openstackdocstheme and reno versions 2020-05-30 16:17:38 +02:00
setup.cfg Cleanup py27 support and docs 2020-04-09 21:25:44 +02:00
setup.py First Pass at Doc Build 2014-05-19 20:56:54 -05:00
tox.ini Cleanup py27 support and docs 2020-04-09 21:25:44 +02:00

README.rst

OpenStack Barbican Specifications

image

This git repository is used to hold approved design specifications for changes 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 story in storyboard. Not all approved blueprints will get fully implemented.

Specifications have to be re-submitted 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

For more information about working with gerrit, see:

https://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.