Browse Source

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
changes/84/551784/4
Nguyen Hai 4 years ago
parent
commit
877df70754
  1. 24
      README.rst
  2. 1
      doc/source/index.rst
  3. 23
      specs/skeleton.rst
  4. 9
      specs/stein/index.rst
  5. 0
      specs/stein/placeholder.rst

24
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/<release>/
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/<release>` directory and posting it for review. The implementation
`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.
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::

1
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

23
specs/skeleton.rst

@ -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
==========

9
specs/stein/index.rst

@ -0,0 +1,9 @@
=====
Stein
=====
.. toctree::
:glob:
:maxdepth: 1
*

0
specs/rocky/placeholder.rst → specs/stein/placeholder.rst

Loading…
Cancel
Save