Open specs repo for Rocky
Glance is now in a specs proposal freeze for Queens, so new specs must be proposed for Rocky. This patch sets up the directories and introduces a new spec-lite template to replace the old strategy of having a single file containing all lite specs. It also reorganizes the index page slightly to make the current cycle's specs more prominent. Change-Id: I85b096fc0c99a70e3ad0d7f8727b7d5ab679c95b
This commit is contained in:
Brian Rosmaita
parent
200483ed3b
commit
19f50813a7
|
|
@ -76,6 +76,7 @@ copyright = u'%s, OpenStack Glance Team' % datetime.date.today().year
|
|||
exclude_patterns = [
|
||||
'_build',
|
||||
'**/template.rst',
|
||||
'**/spec-lite-template.rst',
|
||||
]
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all documents.
|
||||
|
|
|
|||
|
|
@ -15,17 +15,29 @@ This repository contains proposals for new features, or proposals for
|
|||
changes to the current projects that are sufficiently complicated or
|
||||
controversial that in-depth discussion is required.
|
||||
|
||||
Please see the `Glance Contribution Guidelines`_ for information about how to
|
||||
make a proposal to this repository.
|
||||
The Glance Project Team uses two types of design document:
|
||||
|
||||
**Spec**
|
||||
A *spec* is an in-depth description of the proposed feature. It's required
|
||||
for any proposal that affects an API supplied by Glance, for any proposal
|
||||
that changes the data model, for any proposal that would require a database
|
||||
migration, or any change that requires a thorough exploration of alternative
|
||||
ways to accomplish the feature.
|
||||
|
||||
**Spec Lite**
|
||||
A *spec lite* is a brief proposal for a small enhancement to Glance.
|
||||
|
||||
Please see the `Glance Contribution Guidelines`_ for further information about
|
||||
how to make a proposal to this repository.
|
||||
|
||||
.. _Glance Contribution Guidelines: https://docs.openstack.org/developer/glance/contributing/blueprints.html
|
||||
|
||||
Priorities
|
||||
==========
|
||||
|
||||
During each design summit, we agree on what the whole community wants
|
||||
to focus on for the upcoming release. This is the output of those
|
||||
discussions:
|
||||
During each Project Team Gathering (or "design summit"), we agree on what the
|
||||
whole community wants to focus on for the upcoming release. This is the output
|
||||
of those discussions:
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
|
|
@ -36,19 +48,40 @@ discussions:
|
|||
Specifications
|
||||
==============
|
||||
|
||||
Current
|
||||
-------
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
specs/untargeted/*
|
||||
specs/juno/index
|
||||
specs/kilo/index
|
||||
specs/liberty/index
|
||||
specs/mitaka/*
|
||||
specs/newton/*
|
||||
specs/ocata/*
|
||||
specs/pike/*
|
||||
specs/queens/*
|
||||
specs/untargeted/*
|
||||
|
||||
Future
|
||||
------
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
specs/rocky/*
|
||||
|
||||
|
||||
Past
|
||||
----
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
specs/pike/*
|
||||
specs/ocata/*
|
||||
specs/newton/*
|
||||
specs/mitaka/*
|
||||
specs/liberty/index
|
||||
specs/kilo/index
|
||||
specs/juno/index
|
||||
|
||||
====================
|
||||
Image service V2 API
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
../../../spec-lite-template.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../template.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../spec-lite-template.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../template.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../spec-lite-template.rst
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../template.rst
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
====================
|
||||
Rocky Specifications
|
||||
====================
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
Rocky implemented specs:
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
.. implemented/*
|
||||
|
||||
Rocky approved (but not implemented) specs:
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
.. approved/*
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
..
|
||||
This work is licensed under a Creative Commons Attribution 3.0 Unported
|
||||
License.
|
||||
|
||||
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||
|
||||
============================
|
||||
Spec Lite: <Your Title Here>
|
||||
============================
|
||||
|
||||
..
|
||||
Mandatory sections
|
||||
|
||||
:project: <One of: glance, glance_store, python-glanceclient>
|
||||
|
||||
:problem: <What is the driver to make the change.>
|
||||
|
||||
:solution: <High level description what needs to get done. For example: "We
|
||||
need to add client function X.Y.Z to interact with new server
|
||||
functionality Z".>
|
||||
|
||||
:impacts: <All possible \*Impact flags (same as in commit messages) or 'None'.>
|
||||
|
||||
..
|
||||
Optional sections -- delete any that don't apply to this spec lite
|
||||
|
||||
:how: <More technical details than the high level overview of `solution` if
|
||||
needed.>
|
||||
|
||||
:alternatives: <Any alternative approaches that might be worth bringing to
|
||||
discussion.>
|
||||
|
||||
:timeline: <List the milestone by which you expect this work to be completed.>
|
||||
|
||||
:link: <Link to the change in gerrit that already would provide the `solution`.
|
||||
After commiting the Spec Lite depend the change to the Spec Lite commit.>
|
||||
|
||||
:reviewers: <If specific reviewers have agreed to champion this proposal, list
|
||||
them here.>
|
||||
|
||||
:assignee: <If known, list who is going to work on the feature implementation.>
|
||||
Loading…
Reference in New Issue