diff --git a/README.rst b/README.rst index 28e97be..bef72ff 100644 --- a/README.rst +++ b/README.rst @@ -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// -Where there are two sub-directories: +The layout of this repository for Sahara Client is:: - specs//approved: specifications approved but not yet implemented - specs//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// + +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/` 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/`` 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/ + +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:: diff --git a/doc/source/index.rst b/doc/source/index.rst index 70c9d40..4b27551 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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:: diff --git a/specs/backlog/README.rst b/specs/backlog/README.rst new file mode 100644 index 0000000..81f8a99 --- /dev/null +++ b/specs/backlog/README.rst @@ -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. + diff --git a/specs/juno/implemented/anti-affinity-via-server-groups.rst b/specs/juno/anti-affinity-via-server-groups.rst similarity index 100% rename from specs/juno/implemented/anti-affinity-via-server-groups.rst rename to specs/juno/anti-affinity-via-server-groups.rst diff --git a/specs/juno/implemented/append-to-remote-file.rst b/specs/juno/append-to-remote-file.rst similarity index 100% rename from specs/juno/implemented/append-to-remote-file.rst rename to specs/juno/append-to-remote-file.rst diff --git a/specs/juno/approved/.gitignore b/specs/juno/approved/.gitignore deleted file mode 100644 index e69de29..0000000 diff --git a/specs/juno/implemented/cdh-plugin.rst b/specs/juno/cdh-plugin.rst similarity index 100% rename from specs/juno/implemented/cdh-plugin.rst rename to specs/juno/cdh-plugin.rst diff --git a/specs/juno/implemented/ceilometer-integration.rst b/specs/juno/ceilometer-integration.rst similarity index 100% rename from specs/juno/implemented/ceilometer-integration.rst rename to specs/juno/ceilometer-integration.rst diff --git a/specs/juno/implemented/cluster-persist-sahara-configuration.rst b/specs/juno/cluster-persist-sahara-configuration.rst similarity index 100% rename from specs/juno/implemented/cluster-persist-sahara-configuration.rst rename to specs/juno/cluster-persist-sahara-configuration.rst diff --git a/specs/juno/implemented/cluster-secgroups.rst b/specs/juno/cluster-secgroups.rst similarity index 100% rename from specs/juno/implemented/cluster-secgroups.rst rename to specs/juno/cluster-secgroups.rst diff --git a/specs/juno/implemented/edp-move-examples.rst b/specs/juno/edp-move-examples.rst similarity index 100% rename from specs/juno/implemented/edp-move-examples.rst rename to specs/juno/edp-move-examples.rst diff --git a/specs/juno/implemented/edp-refactor-job-manager.rst b/specs/juno/edp-refactor-job-manager.rst similarity index 100% rename from specs/juno/implemented/edp-refactor-job-manager.rst rename to specs/juno/edp-refactor-job-manager.rst diff --git a/specs/juno/implemented/edp-spark-job-type.rst b/specs/juno/edp-spark-job-type.rst similarity index 100% rename from specs/juno/implemented/edp-spark-job-type.rst rename to specs/juno/edp-spark-job-type.rst diff --git a/specs/juno/implemented/edp-spark-standalone.rst b/specs/juno/edp-spark-standalone.rst similarity index 100% rename from specs/juno/implemented/edp-spark-standalone.rst rename to specs/juno/edp-spark-standalone.rst diff --git a/specs/juno/implemented/edp-swift-trust-authentication.rst b/specs/juno/edp-swift-trust-authentication.rst similarity index 100% rename from specs/juno/implemented/edp-swift-trust-authentication.rst rename to specs/juno/edp-swift-trust-authentication.rst diff --git a/specs/juno/implemented/error-handling-in-provisioning.rst b/specs/juno/error-handling-in-provisioning.rst similarity index 100% rename from specs/juno/implemented/error-handling-in-provisioning.rst rename to specs/juno/error-handling-in-provisioning.rst diff --git a/specs/juno/implemented/move-rest-samples-to-docs.rst b/specs/juno/move-rest-samples-to-docs.rst similarity index 100% rename from specs/juno/implemented/move-rest-samples-to-docs.rst rename to specs/juno/move-rest-samples-to-docs.rst diff --git a/specs/juno/redirects b/specs/juno/redirects index 8b74f36..ab89fd0 100644 --- a/specs/juno/redirects +++ b/specs/juno/redirects @@ -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