2f813a9097
When this template was created, the intention behind this section was to know the got-to people for specific specs. Questions like: Who should I ping if I need more Glance insights? Who should I ping to actually get reviews? etc Unfortunately, The reviewers section has turned to a field mostly used to highlight people interested in a specific feature. More often than not, the revieweres listed in this section are not the ones reviewing the patches for the spec. In addition to the above, this section currently separates core reviewers from non-cores. This separation brings no value to this section nor the spec itself. Regardless the size of the team, this section is not bringing any value to the process as reviewers not in this list can as well review the patches as much as the reviewers listed there can also not review the patches. Change-Id: I973d97e82f4561de8d4ac33672494eae0fc15925
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>/implementedA 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/glancePlease note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:
https://wiki.openstack.org/wiki/BlueprintsFor more information about working with gerrit, see:
http://docs.openstack.org/infra/manual/developers.html#development-workflowTo validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:
$ toxAfter 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.