OpenStack Image Management (Glance) Specifications
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Erno Kuvaja d9fd388bda Move Stein implemented specs to 'implemented' 1 month ago
doc Move Stein implemented specs to 'implemented' 1 month ago
priorities Create specs directory for Train 3 months ago
specs Move Stein implemented specs to 'implemented' 1 month ago
tests Remove reviewers section from template 3 years ago
.gitignore Switch to stestr 11 months ago
.gitreview OpenDev Migration Patch 2 months ago
.stestr.conf Switch to stestr 11 months ago
.zuul.yaml import zuul job settings from project-config 9 months ago
LICENSE Add base glance-specs framework 5 years ago
README.rst Remove team diversity tags note in README 10 months ago
requirements.txt Switch to stestr 11 months ago
setup.cfg Change openstack-dev to openstack-discuss 6 months ago
setup.py Add base glance-specs framework 5 years ago
tox.ini Merge "Switch to stestr" 6 months ago

README.rst

Team and repository tags

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:

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