Specification Repository Backlog Refactor

This change implements the backlog refactor.

Changes
* adding a backlog directory to specs directory
* adding a README to the backlog directory
* removing approved directory in specs/juno
* moving implemented specs from specs/juno/implemented to specs/juno
* removing specs/juno/redirects
* updating README to highlight new directory structure, and general
  cleanup
* updating doc index to use new locations for juno specs
* adding backlog to doc index
* inverting redirects for older implemented juno specs

Change-Id: I8d954e347ceaad3e9ab32ce9162d7ac36e82ebd3
Implements: blueprint add-backlog-to-specs
This commit is contained in:
Michael McCune 2014-11-25 13:25:49 -05:00
parent 215ac46541
commit 89d4deb2f5
18 changed files with 71 additions and 33 deletions

View File

@ -6,39 +6,53 @@ This git repository is used to hold approved design specifications for additions
to the Sahara 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 layout of this repository is::
The layout of this repository for Sahara specifications is::
specs/<release>/
Where there are two sub-directories:
The layout of this repository for Sahara Client is::
specs/<release>/approved: specifications approved but not yet implemented
specs/<release>/implemented: implemented specifications
specs/saharaclient/
This directory structure allows you to see what we thought about doing,
decided to do, and actually got done. Users interested in functionality in a
given release should only refer to the ``implemented`` directory.
When a new version of Sahara Client is released the implemented blueprints
will be moved to a directory specific to that release::
You can find an example spec in `doc/source/specs/template.rst`.
specs/saharaclient/<release>/
You can find an example spec in ``specs/template.rst``.
For specifications that have been reviewed and approved but have not been
implemented::
specs/backlog/
Specifications in this directory indicate the original author has either
become unavailable, or has indicated that they are not going to implement the
specification. The specifications found here are available as projects for
people looking to get involved with Sahara. If you are interested in
claiming a spec, start by posting a review for the specification that moves it
from this directory to the next active release. Please set yourself as the new
`primary assignee` and maintain the original author in the `other contributors`
list.
Specifications are proposed for a given release by adding them to the
`specs/<release>` 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.
``specs/<release>`` directory and posting it for review. Not all approved
blueprints will get fully implemented. The implementation status of a
blueprint for a given release can be found by looking at the blueprint in
launchpad::
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.
http://blueprints.launchpad.net/sahara/<blueprint-name>
Incomplete 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 and for the Juno-1 development milestone,
this repository was not used for spec reviews.
Reviews prior to Juno were completed entirely through Launchpad blueprints::
this repository was not used for spec reviews. Reviews prior to Juno were
completed entirely through Launchpad blueprints::
http://blueprints.launchpad.net/sahara
Starting from the Juno-1 developement milestone Sahara performs the pilot of
the specs repos approach.
Please note, Launchpad blueprints are still used for tracking the
current status of blueprints. For more information, see::

View File

@ -10,7 +10,7 @@ Juno implemented specs:
:glob:
:maxdepth: 1
specs/juno/implemented/*
specs/juno/*
Kilo specs:
@ -20,6 +20,14 @@ Kilo specs:
specs/kilo/*
Unimplemented backlog specs:
.. toctree::
:glob:
:maxdepth: 1
specs/backlog/*
Sahara client approved specs:
.. toctree::

16
specs/backlog/README.rst Normal file
View File

@ -0,0 +1,16 @@
=======
Backlog
=======
This directory is for specifications that have been approved but not yet
implemented. If you are interested in implementing one of these specifications
submit a review request moving it to the appropriate release.
The updated review should reflect the new primary assignee. Please maintain
all previous assignees in the list of Other Contributors.
If a specification has been partially implemented, the document in the backlog
will contain information of what has been completed.

View File

View File

@ -1,13 +1,13 @@
anti-affinity-via-server-groups.rst implemented/anti-affinity-via-server-groups.rst
append-to-remote-file.rst implemented/append-to-remote-file.rst
cdh-plugin.rst implemented/cdh-plugin.rst
ceilometer-integration.rst implemented/ceilometer-integration.rst
cluster-persist-sahara-configuration.rst implemented/cluster-persist-sahara-configuration.rst
cluster-secgroups.rst implemented/cluster-secgroups.rst
edp-move-examples.rst implemented/edp-move-examples.rst
edp-refactor-job-manager.rst implemented/edp-refactor-job-manager.rst
edp-spark-job-type.rst implemented/edp-spark-job-type.rst
edp-spark-standalone.rst implemented/edp-spark-standalone.rst
edp-swift-trust-authentication.rst implemented/edp-swift-trust-authentication.rst
error-handling-in-provisioning.rst implemented/error-handling-in-provisioning.rst
move-rest-samples-to-docs.rst implemented/move-rest-samples-to-docs.rst
implemented/anti-affinity-via-server-groups.rst anti-affinity-via-server-groups.rst
implemented/append-to-remote-file.rst append-to-remote-file.rst
implemented/cdh-plugin.rst cdh-plugin.rst
implemented/ceilometer-integration.rst ceilometer-integration.rst
implemented/cluster-persist-sahara-configuration.rst cluster-persist-sahara-configuration.rst
implemented/cluster-secgroups.rst cluster-secgroups.rst
implemented/edp-move-examples.rst edp-move-examples.rst
implemented/edp-refactor-job-manager.rst edp-refactor-job-manager.rst
implemented/edp-spark-job-type.rst edp-spark-job-type.rst
implemented/edp-spark-standalone.rst edp-spark-standalone.rst
implemented/edp-swift-trust-authentication.rst edp-swift-trust-authentication.rst
implemented/error-handling-in-provisioning.rst error-handling-in-provisioning.rst
implemented/move-rest-samples-to-docs.rst move-rest-samples-to-docs.rst