From 19f50813a72828a256f11b27d2657f1f819e3378 Mon Sep 17 00:00:00 2001 From: Brian Rosmaita Date: Mon, 2 Oct 2017 08:27:51 -0400 Subject: [PATCH] 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 --- doc/source/conf.py | 1 + doc/source/index.rst | 59 +++++++++++++++---- .../approved/glance/spec-lite-template.rst | 1 + specs/rocky/approved/glance/template.rst | 1 + .../glance_store/spec-lite-template.rst | 1 + .../rocky/approved/glance_store/template.rst | 1 + .../spec-lite-template.rst | 1 + .../approved/python-glanceclient/template.rst | 1 + specs/rocky/index.rst | 23 ++++++++ specs/spec-lite-template.rst | 41 +++++++++++++ 10 files changed, 117 insertions(+), 13 deletions(-) create mode 120000 specs/rocky/approved/glance/spec-lite-template.rst create mode 120000 specs/rocky/approved/glance/template.rst create mode 120000 specs/rocky/approved/glance_store/spec-lite-template.rst create mode 120000 specs/rocky/approved/glance_store/template.rst create mode 120000 specs/rocky/approved/python-glanceclient/spec-lite-template.rst create mode 120000 specs/rocky/approved/python-glanceclient/template.rst create mode 100644 specs/rocky/index.rst create mode 100644 specs/spec-lite-template.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 68cd4b7c..90267703 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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. diff --git a/doc/source/index.rst b/doc/source/index.rst index f2a0eb89..e0fc94d6 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 diff --git a/specs/rocky/approved/glance/spec-lite-template.rst b/specs/rocky/approved/glance/spec-lite-template.rst new file mode 120000 index 00000000..d33c41f4 --- /dev/null +++ b/specs/rocky/approved/glance/spec-lite-template.rst @@ -0,0 +1 @@ +../../../spec-lite-template.rst \ No newline at end of file diff --git a/specs/rocky/approved/glance/template.rst b/specs/rocky/approved/glance/template.rst new file mode 120000 index 00000000..26e0efd9 --- /dev/null +++ b/specs/rocky/approved/glance/template.rst @@ -0,0 +1 @@ +../../../template.rst \ No newline at end of file diff --git a/specs/rocky/approved/glance_store/spec-lite-template.rst b/specs/rocky/approved/glance_store/spec-lite-template.rst new file mode 120000 index 00000000..d33c41f4 --- /dev/null +++ b/specs/rocky/approved/glance_store/spec-lite-template.rst @@ -0,0 +1 @@ +../../../spec-lite-template.rst \ No newline at end of file diff --git a/specs/rocky/approved/glance_store/template.rst b/specs/rocky/approved/glance_store/template.rst new file mode 120000 index 00000000..26e0efd9 --- /dev/null +++ b/specs/rocky/approved/glance_store/template.rst @@ -0,0 +1 @@ +../../../template.rst \ No newline at end of file diff --git a/specs/rocky/approved/python-glanceclient/spec-lite-template.rst b/specs/rocky/approved/python-glanceclient/spec-lite-template.rst new file mode 120000 index 00000000..d33c41f4 --- /dev/null +++ b/specs/rocky/approved/python-glanceclient/spec-lite-template.rst @@ -0,0 +1 @@ +../../../spec-lite-template.rst \ No newline at end of file diff --git a/specs/rocky/approved/python-glanceclient/template.rst b/specs/rocky/approved/python-glanceclient/template.rst new file mode 120000 index 00000000..26e0efd9 --- /dev/null +++ b/specs/rocky/approved/python-glanceclient/template.rst @@ -0,0 +1 @@ +../../../template.rst \ No newline at end of file diff --git a/specs/rocky/index.rst b/specs/rocky/index.rst new file mode 100644 index 00000000..fcbe5870 --- /dev/null +++ b/specs/rocky/index.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/* diff --git a/specs/spec-lite-template.rst b/specs/spec-lite-template.rst new file mode 100644 index 00000000..0a3b4a6f --- /dev/null +++ b/specs/spec-lite-template.rst @@ -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: +============================ + +.. + Mandatory sections + +:project: + +:problem: + +:solution: + +:impacts: + +.. + Optional sections -- delete any that don't apply to this spec lite + +:how: + +:alternatives: + +:timeline: + +:link: + +:reviewers: + +:assignee: