RETIRED, Congress Design Specifications
Go to file
Ghanshyam Mann 580a34d3e5 [ussuri][goal] Drop python 2.7 support
OpenStack is dropping the py2.7 support in ussuri cycle.

specs repo has py2 specific requirement which is removed
or tox optimization.

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Change-Id: Icd02e70d4884c252ed4ada7cd224c0451854cf31
2019-12-13 00:48:41 +00:00
doc/source Update Sphinx version and switch to openstackdocstheme 2019-06-21 12:48:16 +05:30
specs Update Sphinx version and switch to openstackdocstheme 2019-06-21 12:48:16 +05:30
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 OpenDev Migration Patch 2019-04-19 19:36:15 +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 Replace git.openstack.org URLs with opendev.org URLs 2019-05-27 14:07:20 +08:00
requirements.txt [ussuri][goal] Drop python 2.7 support 2019-12-13 00:48:41 +00:00
setup.cfg Change openstack-dev to openstack-discuss 2018-12-04 10:01:04 +05:30
setup.py adding all spec files 2014-08-24 17:33:33 -05:00
tox.ini [ussuri][goal] Drop python 2.7 support 2019-12-13 00:48:41 +00:00

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.