From 877df70754f21b2b69141a70238fbd5eb588b155 Mon Sep 17 00:00:00 2001 From: Nguyen Hai Date: Mon, 12 Mar 2018 01:10:33 +0900 Subject: [PATCH] Delete redundant rst files and update README - Update outdated links in README - Remove skeleton.rst, this file is unnecessary. - Add Stein Specifications dir. - Move placeholder.rst to stein dir, because there is a blueprint accepted in rocky dir. Change-Id: I5fd436db02517404d3aca3114498206f164bca44 --- README.rst | 24 ++++++++++-------------- doc/source/index.rst | 1 + specs/skeleton.rst | 23 ----------------------- specs/stein/index.rst | 9 +++++++++ specs/{rocky => stein}/placeholder.rst | 0 5 files changed, 20 insertions(+), 37 deletions(-) delete mode 100644 specs/skeleton.rst create mode 100644 specs/stein/index.rst rename specs/{rocky => stein}/placeholder.rst (100%) diff --git a/README.rst b/README.rst index a312127ce..f2cd85b0d 100644 --- a/README.rst +++ b/README.rst @@ -2,8 +2,8 @@ Team and repository tags ======================== -.. image:: http://governance.openstack.org/badges/neutron-specs.svg - :target: http://governance.openstack.org/reference/tags/index.html +.. image:: https://governance.openstack.org/tc/badges/neutron-specs.svg + :target: https://governance.openstack.org/tc/reference/tags/index.html .. Change things from this point on @@ -12,33 +12,29 @@ OpenStack Neutron Specifications ================================== This git repository is used to hold approved design specifications for additions -to the Neutron project. Reviews of the specs are done in gerrit, using a +to the Neutron 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:: specs// -You can find an example spec in `doc/source/specs/template.rst`. A -skeleton that contains all the sections required for a spec -file is located in `doc/source/specs/skeleton.rst` and can -be copied, then filled in with the details of a new blueprint for -convenience. +You can find an example spec in `specs/template.rst`. Specifications are proposed for a given release by adding them to the -`specs/` directory and posting it for review. The implementation +`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. +blueprint in launchpad. Not all approved blueprints will get fully implemented. -Specifications have to be re-proposed for every release. The review may be +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, this repository was not used for spec -reviews. Reviews prior to Juno were completed entirely through Launchpad +reviews. Reviews prior to Juno were completed entirely through Launchpad blueprints:: - http://blueprints.launchpad.net/neutron + https://blueprints.launchpad.net/neutron Please note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:: @@ -47,7 +43,7 @@ current status of blueprints. For more information, see:: For more information about working with gerrit, see:: - http://docs.openstack.org/infra/manual/developers.html#development-workflow + https://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:: diff --git a/doc/source/index.rst b/doc/source/index.rst index 93bc43c63..10c31c216 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -10,6 +10,7 @@ Specifications and RFEs .. toctree:: :maxdepth: 2 + specs/stein/index specs/rocky/index specs/queens/index specs/pike/index diff --git a/specs/skeleton.rst b/specs/skeleton.rst deleted file mode 100644 index 7ffc364de..000000000 --- a/specs/skeleton.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. - This work is licensed under a Creative Commons Attribution 3.0 Unported - License. - - http://creativecommons.org/licenses/by/3.0/legalcode - -========================================== -Title of your RFE -========================================== - - -Problem Description -=================== - - -Proposed Change -=============== - - -References -========== - - diff --git a/specs/stein/index.rst b/specs/stein/index.rst new file mode 100644 index 000000000..08215a424 --- /dev/null +++ b/specs/stein/index.rst @@ -0,0 +1,9 @@ +===== +Stein +===== + +.. toctree:: + :glob: + :maxdepth: 1 + + * diff --git a/specs/rocky/placeholder.rst b/specs/stein/placeholder.rst similarity index 100% rename from specs/rocky/placeholder.rst rename to specs/stein/placeholder.rst