From 3de1984deeded01289a225de66be82f3a8c05057 Mon Sep 17 00:00:00 2001 From: cdiep Date: Tue, 8 Dec 2015 10:44:57 -0800 Subject: [PATCH] Re-organize the RefStack specs directory. Change-Id: I02da57c2b7d888ae49bd4f96ba8fb46016d16e7d --- specs/README.rst | 54 +++++++++++++------ .../implemented}/rsa-key-existence-check.rst | 0 ...ty_to_upload_a_complete_tempest_config.rst | 0 .../refstack-org-defcore-reports.rst | 0 .../approved}/refstack-org-gearman-tester.rst | 0 .../refstack-org-result-visualization.rst | 0 .../approved}/refstack-org-tcup-base.rst | 0 .../{approved => prior/implemented}/api-v1.md | 0 .../implemented}/coretest-testid.rst | 0 .../identify-code-to-deprecate.rst | 0 .../refstack-org-api-cloud-uuid.rst | 0 .../refstack-org-test-result-json-schema.rst | 0 ...seperate_refstack_tester_from_refstack.rst | 0 ...y-uploads-by-only-sending-pass-results.rst | 0 .../implemented}/test-record-api.rst | 0 15 files changed, 37 insertions(+), 17 deletions(-) rename specs/{proposed => mitaka/implemented}/rsa-key-existence-check.rst (100%) rename specs/{ => prior}/approved/ability_to_upload_a_complete_tempest_config.rst (100%) rename specs/{proposed => prior/approved}/refstack-org-defcore-reports.rst (100%) rename specs/{proposed => prior/approved}/refstack-org-gearman-tester.rst (100%) rename specs/{proposed => prior/approved}/refstack-org-result-visualization.rst (100%) rename specs/{proposed => prior/approved}/refstack-org-tcup-base.rst (100%) rename specs/{approved => prior/implemented}/api-v1.md (100%) rename specs/{proposed => prior/implemented}/coretest-testid.rst (100%) rename specs/{approved => prior/implemented}/identify-code-to-deprecate.rst (100%) rename specs/{proposed => prior/implemented}/refstack-org-api-cloud-uuid.rst (100%) rename specs/{approved => prior/implemented}/refstack-org-test-result-json-schema.rst (100%) rename specs/{approved => prior/implemented}/seperate_refstack_tester_from_refstack.rst (100%) rename specs/{approved => prior/implemented}/simplify-uploads-by-only-sending-pass-results.rst (100%) rename specs/{proposed => prior/implemented}/test-record-api.rst (100%) diff --git a/specs/README.rst b/specs/README.rst index 6328bbdf..46e947db 100644 --- a/specs/README.rst +++ b/specs/README.rst @@ -1,34 +1,54 @@ -================================== +======================= Refstack Specifications -================================== +======================= This folder is used to hold design specifications for additions -to the Refstack project. Reviews of the specs are done in gerrit, using a similar -workflow to how we review and merge changes to the code itself. +to the RefStack project. Reviews of the specs are done in gerrit, using a +similar workflow to how we review and merge changes to the code itself. -Specifications are proposed by adding an .rst file to the `specs/proposed` directory and posting it for review. Not all approved blueprints will get fully implemented. You can find an example spec in `/specs/template.rst`. +The layout of this folder is as follows:: -When a spec has passed the review process and discussions in our weekly meetings it will -be moved to 'specs/approved/'. At that time the blueprint will be marked as approved and assigned to someone. + specs// + specs//approved + specs//implemented -Once a spec has been fully implemented, meaning a patch has landed that references the blueprint, it will be moved again to 'specs/completed'. +The lifecycle of a specification +-------------------------------- -Prior to April 2014, this method was not used for spec -reviews. Prior reviews were completed entirely through Launchpad -blueprints:: +Specifications are proposed by adding an .rst file to the +``specs//approved`` directory and posting it for review. You can +find an example specification in ``/specs/template.rst``. - http://blueprints.launchpad.net/refstack +Once a specification has been fully implemented, meaning a patch has landed, +it will be moved to the ``implemented`` directory and the corresponding +blueprint will be marked as complete. -Please note, Launchpad blueprints are still used for tracking the -current status of blueprints. For more information, see:: +`Specifications are only approved for a single release`. If a specification +was previously approved but not implemented (or not completely implemented), +then the specification needs to be re-proposed by copying (not move) it to +the right directory for the current release. - https://wiki.openstack.org/wiki/Blueprints +Previously approved specifications +---------------------------------- + +The RefStack specs directory was re-structured during the Mitaka cycle. +Therefore, the specs approved and implemented prior to the Mitaka cycle will be +saved in the ``specs/prior/`` directories. + +Others +------ + +Please note, Launchpad blueprints are still used for tracking the status of the +blueprints. For more information, see:: + + https://wiki.openstack.org/wiki/Blueprints + https://blueprints.launchpad.net/refstack For more information about working with gerrit, see:: - http://docs.openstack.org/infra/manual/developers.html#development-workflow + http://docs.openstack.org/infra/manual/developers.html#development-workflow To validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:: - $ tox + $ tox diff --git a/specs/proposed/rsa-key-existence-check.rst b/specs/mitaka/implemented/rsa-key-existence-check.rst similarity index 100% rename from specs/proposed/rsa-key-existence-check.rst rename to specs/mitaka/implemented/rsa-key-existence-check.rst diff --git a/specs/approved/ability_to_upload_a_complete_tempest_config.rst b/specs/prior/approved/ability_to_upload_a_complete_tempest_config.rst similarity index 100% rename from specs/approved/ability_to_upload_a_complete_tempest_config.rst rename to specs/prior/approved/ability_to_upload_a_complete_tempest_config.rst diff --git a/specs/proposed/refstack-org-defcore-reports.rst b/specs/prior/approved/refstack-org-defcore-reports.rst similarity index 100% rename from specs/proposed/refstack-org-defcore-reports.rst rename to specs/prior/approved/refstack-org-defcore-reports.rst diff --git a/specs/proposed/refstack-org-gearman-tester.rst b/specs/prior/approved/refstack-org-gearman-tester.rst similarity index 100% rename from specs/proposed/refstack-org-gearman-tester.rst rename to specs/prior/approved/refstack-org-gearman-tester.rst diff --git a/specs/proposed/refstack-org-result-visualization.rst b/specs/prior/approved/refstack-org-result-visualization.rst similarity index 100% rename from specs/proposed/refstack-org-result-visualization.rst rename to specs/prior/approved/refstack-org-result-visualization.rst diff --git a/specs/proposed/refstack-org-tcup-base.rst b/specs/prior/approved/refstack-org-tcup-base.rst similarity index 100% rename from specs/proposed/refstack-org-tcup-base.rst rename to specs/prior/approved/refstack-org-tcup-base.rst diff --git a/specs/approved/api-v1.md b/specs/prior/implemented/api-v1.md similarity index 100% rename from specs/approved/api-v1.md rename to specs/prior/implemented/api-v1.md diff --git a/specs/proposed/coretest-testid.rst b/specs/prior/implemented/coretest-testid.rst similarity index 100% rename from specs/proposed/coretest-testid.rst rename to specs/prior/implemented/coretest-testid.rst diff --git a/specs/approved/identify-code-to-deprecate.rst b/specs/prior/implemented/identify-code-to-deprecate.rst similarity index 100% rename from specs/approved/identify-code-to-deprecate.rst rename to specs/prior/implemented/identify-code-to-deprecate.rst diff --git a/specs/proposed/refstack-org-api-cloud-uuid.rst b/specs/prior/implemented/refstack-org-api-cloud-uuid.rst similarity index 100% rename from specs/proposed/refstack-org-api-cloud-uuid.rst rename to specs/prior/implemented/refstack-org-api-cloud-uuid.rst diff --git a/specs/approved/refstack-org-test-result-json-schema.rst b/specs/prior/implemented/refstack-org-test-result-json-schema.rst similarity index 100% rename from specs/approved/refstack-org-test-result-json-schema.rst rename to specs/prior/implemented/refstack-org-test-result-json-schema.rst diff --git a/specs/approved/seperate_refstack_tester_from_refstack.rst b/specs/prior/implemented/seperate_refstack_tester_from_refstack.rst similarity index 100% rename from specs/approved/seperate_refstack_tester_from_refstack.rst rename to specs/prior/implemented/seperate_refstack_tester_from_refstack.rst diff --git a/specs/approved/simplify-uploads-by-only-sending-pass-results.rst b/specs/prior/implemented/simplify-uploads-by-only-sending-pass-results.rst similarity index 100% rename from specs/approved/simplify-uploads-by-only-sending-pass-results.rst rename to specs/prior/implemented/simplify-uploads-by-only-sending-pass-results.rst diff --git a/specs/proposed/test-record-api.rst b/specs/prior/implemented/test-record-api.rst similarity index 100% rename from specs/proposed/test-record-api.rst rename to specs/prior/implemented/test-record-api.rst