openstack/glance-specs
Code Issues Proposed changes
OpenStack Image Management (Glance) Specifications
181 Commits 1 Branch 0 Tags 8.9 MiB
Python 69%
Shell 26%
PHP 5%
9f7278d435
Go to file
Nikhil Komawar 9f7278d435 Start Ocata specs proposals 
Some of the Newton specs did not get enough attention from cores
during the cycle. Let's start the Ocata folder for starting planning on
the specs for next cycle.

This needs to be started/merged in Newton for people to start planning
on writing specs and then help the glance team and community
determine/plan work for Ocata.

Co-Authored-By: Nikhil Komawar <nik.komawar@gmail.com>
Co-Authored-By: Brian Rosmaita <brian.rosmaita@rackspace.com>

Change-Id: I16d1dd18c3efceb2245239f9c95483e717c70c4d
2016-08-09 17:51:52 +00:00
doc/source Start Ocata specs proposals 2016-08-09 17:51:52 +00:00
priorities Add Glance priorities for Mitaka 2015-10-30 01:29:29 +00:00
specs Start Ocata specs proposals 2016-08-09 17:51:52 +00:00
tests Remove reviewers section from template 2016-05-13 15:37:10 -05: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.