openstack
/
congress-specs
Code Issues Proposed changes
RETIRED, Congress Design Specifications
134 Commits 1 Branch 0 Tags 1.3 MiB
Go to file
Doug Hellmann 8fa7df61bf comment out stein section of toctree 
There are no stein specs, so using a glob pattern to include them in the
output causes a warning which then breaks the build. Comment that
toctree out for now.

Change-Id: I97ca5dae30e59023256e6368aa98953f7cb157dd
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
 		2018-10-03 17:10:34 -04:00
doc/source comment out stein section of toctree 2018-10-03 17:10:34 -04:00
specs Setup Stein specs dir 2018-08-09 17:30:46 -07:00
tests Enable specs sphinx build 2015-08-31 10:53:13 +08:00
.gitignore Switch to stestr 2018-08-10 00:15:16 +00:00
.gitreview Update .gitreview file to reflect repo rename 2015-04-18 15:17:27 +00:00
.stestr.conf Switch to stestr 2018-08-10 00:15:16 +00:00
.zuul.yaml import zuul job settings from project-config 2018-08-17 17:27:20 +09:00
LICENSE adding all spec files 2014-08-24 17:33:33 -05:00
README.rst Show team and repo badges on README 2016-11-25 14:00:56 +01:00
requirements.txt Switch to stestr 2018-08-10 00:15:16 +00:00
setup.cfg Changed the home-page link for congress-specs 2016-10-24 17:50:31 +05:30
setup.py adding all spec files 2014-08-24 17:33:33 -05:00
tox.ini Switch to stestr 2018-08-10 00:15:16 +00:00

README.rst

Team and repository tags

image

OpenStack Congress Specifications

This git repository is used to hold approved design specifications for additions to the Congress 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.

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

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.