openstack/glance-specs
Code Issues Proposed changes
OpenStack Image Management (Glance) Specifications
30 Commits 1 Branch 0 Tags 8.9 MiB
Python 69%
Shell 26%
PHP 5%
d3e34471f1
Go to file
Chris Yeoh d3e34471f1 Add requirement for APIImpact flag 
Adds a requirement for an APIImpact flag in
the commit message for a proposed spec if it proposes
changes to the Glance REST API. This will make it
much easier for people such as the API WG who want to
review API changes across OpenStack to find and
review proposed API changes.

Change-Id: Ic83a797b3feae28052abba78ac9abc4a07f4063e
2014-10-29 13:22:45 +10:30
doc/source Use the current date for the copyright statement 2014-10-20 15:33:25 -04:00
specs Add requirement for APIImpact flag 2014-10-29 13:22:45 +10:30
tests Adds requirement of 'Reviewers' to the specs 2014-10-28 16:37:35 -04:00
.gitignore Add base glance-specs framework 2014-05-28 17:20:37 -07:00
.gitreview Added .gitreview 2014-05-08 19:05:52 +00:00
.testr.conf Add base glance-specs framework 2014-05-28 17:20:37 -07:00
LICENSE Add base glance-specs framework 2014-05-28 17:20:37 -07:00
README.rst Fix template and reST online renderer links 2014-07-18 16:19:52 +05:30
requirements.txt Merge "Remove docutils pin" 2014-10-14 18:28:58 +00:00
setup.cfg Add base glance-specs framework 2014-05-28 17:20:37 -07:00
setup.py Add base glance-specs framework 2014-05-28 17:20:37 -07:00
tox.ini Add base glance-specs framework 2014-05-28 17:20:37 -07:00

README.rst

OpenStack Glance Specifications

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

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. Please do not checkin the generated HTML files as a part of your commit.