openstack/glance-specs
Code Issues Proposed changes
OpenStack Image Management (Glance) Specifications
164 Commits 1 Branch 0 Tags 8.9 MiB
Python 69%
Shell 26%
PHP 5%
e2c9e4c063
Go to file
bria4010 e2c9e4c063 Fix markup in README 
There's missing RST markup in the readme file that's causing a
confusing display in the rendered document.  This commit fixes
that mistake.

Change-Id: If3e406192feb04573073673762c64764ebc3a255
2016-04-27 09:45:01 -05:00
doc/source Merge "Replace deprecated library function os.popen() with subprocess" 2016-03-08 18:40:46 +00:00
priorities Add Glance priorities for Mitaka 2015-10-30 01:29:29 +00:00
specs Merge "Update 'Alternatives' section of the import spec" 2016-04-25 14:57:04 +00:00
tests Merge "Adds Image service v1 and v2 specification info in general" 2014-12-11 23:11:32 +00:00
.gitignore Adds Image service v1 and v2 specification info in general 2014-12-05 16:50:39 -06: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 markup in README 2016-04-27 09:45:01 -05:00
requirements.txt Revert "Cap Pillow to fix doc gates" 2015-10-25 22:39:35 +11: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 general layout of this repository is:

specs/<release>/

You can find an example spec in specs/template.rst.

Beginning with the Mitaka release, there is a further subdivision into:

specs/<release>/approved
specs/<release>/implemented

A specification is proposed for a given release by adding it to the specs/<release>/approved 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.

When a feature has been completed, its specification will be moved to the 'implemented' directory for the release in which it was 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:

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