diff --git a/doc/source/conf.py b/doc/source/conf.py index 11b54e014..ec0b7fea8 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -63,7 +63,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Neutron Specs' +project = u'Neutron Specifications' copyright = u'%s, OpenStack Neutron Team' % datetime.date.today().year # The language for content autogenerated by Sphinx. Refer to documentation diff --git a/doc/source/index.rst b/doc/source/index.rst index 6590f5f39..93bc43c63 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -4,147 +4,40 @@ Neutron Project Specifications ============================== -Rocky -===== +Specifications and RFEs +======================= + +.. toctree:: + :maxdepth: 2 + + specs/rocky/index + specs/queens/index + specs/pike/index + specs/ocata/index + specs/newton/index + specs/mitaka/index + specs/liberty/index + specs/kilo/index + specs/juno/index + +Backlogs +======== .. toctree:: :glob: - :maxdepth: 1 + :maxdepth: 2 - specs/rocky/* + specs/backlog/index -Queens -====== +Stadium Health +============== .. toctree:: :glob: - :maxdepth: 1 + :maxdepth: 2 - specs/queens/* + specs/stadium/index -Pike -==== - -.. toctree:: - :glob: - :maxdepth: 1 - - specs/pike/* - -Ocata -===== - -.. toctree:: - :maxdepth: 1 - - Postmortem documentation - -.. toctree:: - :glob: - :maxdepth: 1 - -Newton -====== - -.. toctree:: - :maxdepth: 1 - - Postmortem documentation - -.. toctree:: - :glob: - :maxdepth: 1 - - specs/newton/* - -Mitaka -====== - -.. toctree:: - :maxdepth: 1 - - Postmortem documentation - -.. toctree:: - :glob: - :maxdepth: 1 - - specs/mitaka/* - -Liberty -======= - -.. toctree:: - :glob: - :maxdepth: 1 - - specs/liberty/* - -Kilo -==== - -.. toctree:: - :glob: - :maxdepth: 1 - - specs/kilo/* - -Juno -==== - -.. toctree:: - :glob: - :maxdepth: 1 - - specs/juno/* - -Backlog -======= - -.. toctree:: - :glob: - :maxdepth: 1 - - specs/backlog/** - -Stadium -======= - -.. toctree:: - :glob: - :maxdepth: 1 - - specs/stadium/* - -Queens ------- - -.. toctree:: - :glob: - :maxdepth: 1 - - specs/stadium/queens/* - -Pike ----- - -.. toctree:: - :glob: - :maxdepth: 1 - - specs/stadium/pike/* - -Ocata ------ - -.. toctree:: - :glob: - :maxdepth: 1 - - specs/stadium/ocata/* - -================== -Indices and tables -================== +.. rubric:: Indices and tables * :ref:`search` diff --git a/specs/backlog/index.rst b/specs/backlog/index.rst new file mode 100644 index 000000000..5705c9530 --- /dev/null +++ b/specs/backlog/index.rst @@ -0,0 +1,9 @@ +======= +Backlog +======= + +.. toctree:: + :glob: + :maxdepth: 1 + + ** diff --git a/specs/juno/index.rst b/specs/juno/index.rst new file mode 100644 index 000000000..dc1101aa2 --- /dev/null +++ b/specs/juno/index.rst @@ -0,0 +1,9 @@ +==== +Juno +==== + +.. toctree:: + :glob: + :maxdepth: 1 + + * diff --git a/specs/kilo/index.rst b/specs/kilo/index.rst new file mode 100644 index 000000000..46f9a00b7 --- /dev/null +++ b/specs/kilo/index.rst @@ -0,0 +1,9 @@ +==== +Kilo +==== + +.. toctree:: + :glob: + :maxdepth: 1 + + * diff --git a/specs/liberty/index.rst b/specs/liberty/index.rst new file mode 100644 index 000000000..b66e0fca8 --- /dev/null +++ b/specs/liberty/index.rst @@ -0,0 +1,9 @@ +======= +Liberty +======= + +.. toctree:: + :glob: + :maxdepth: 1 + + * diff --git a/specs/mitaka/index.rst b/specs/mitaka/index.rst new file mode 100644 index 000000000..b5fcd5644 --- /dev/null +++ b/specs/mitaka/index.rst @@ -0,0 +1,14 @@ +====== +Mitaka +====== + +.. toctree:: + :maxdepth: 1 + + [Postmortem] + +.. toctree:: + :glob: + :maxdepth: 1 + + * diff --git a/specs/mitaka/postmortem/postmortem.rst b/specs/mitaka/postmortem/postmortem.rst index 187da89f3..91f19bea1 100644 --- a/specs/mitaka/postmortem/postmortem.rst +++ b/specs/mitaka/postmortem/postmortem.rst @@ -4,8 +4,8 @@ http://creativecommons.org/licenses/by/3.0/legalcode -Postmortem documentation -======================== +Mitaka Postmortem documentation +=============================== .. contents:: diff --git a/specs/newton/index.rst b/specs/newton/index.rst new file mode 100644 index 000000000..9acc44777 --- /dev/null +++ b/specs/newton/index.rst @@ -0,0 +1,14 @@ +====== +Newton +====== + +.. toctree:: + :maxdepth: 1 + + [Postmortem] + +.. toctree:: + :glob: + :maxdepth: 1 + + * diff --git a/specs/newton/postmortem/postmortem.rst b/specs/newton/postmortem/postmortem.rst index 59d50c756..cdef78eb8 100644 --- a/specs/newton/postmortem/postmortem.rst +++ b/specs/newton/postmortem/postmortem.rst @@ -4,8 +4,8 @@ http://creativecommons.org/licenses/by/3.0/legalcode -Postmortem documentation -======================== +Newton Postmortem documentation +=============================== .. contents:: diff --git a/specs/ocata/index.rst b/specs/ocata/index.rst new file mode 100644 index 000000000..ff5554e09 --- /dev/null +++ b/specs/ocata/index.rst @@ -0,0 +1,8 @@ +===== +Ocata +===== + +.. toctree:: + :maxdepth: 1 + + [Postmortem] diff --git a/specs/ocata/postmortem/postmortem.rst b/specs/ocata/postmortem/postmortem.rst index 8ba851ff7..b8f53cea1 100644 --- a/specs/ocata/postmortem/postmortem.rst +++ b/specs/ocata/postmortem/postmortem.rst @@ -4,8 +4,8 @@ http://creativecommons.org/licenses/by/3.0/legalcode -Postmortem documentation -======================== +Ocata Postmortem documentation +============================== .. contents:: diff --git a/specs/pike/index.rst b/specs/pike/index.rst new file mode 100644 index 000000000..1bd6990c4 --- /dev/null +++ b/specs/pike/index.rst @@ -0,0 +1,9 @@ +==== +Pike +==== + +.. toctree:: + :glob: + :maxdepth: 1 + + * diff --git a/specs/queens/index.rst b/specs/queens/index.rst new file mode 100644 index 000000000..515891d23 --- /dev/null +++ b/specs/queens/index.rst @@ -0,0 +1,5 @@ +====== +Queens +====== + +No spec document landed. diff --git a/specs/queens/placeholder.rst b/specs/queens/placeholder.rst deleted file mode 100644 index 903802d1c..000000000 --- a/specs/queens/placeholder.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. - This work is licensed under a Creative Commons Attribution 3.0 Unported - License. - - http://creativecommons.org/licenses/by/3.0/legalcode - -================== -(Placeholder Spec) -================== - -This file is just a placeholder for the specs directory. -It will be removed soon after some spec is merged. - -The latest spec template is found at ``specs/template.rst`` -in the ``neutron-specs`` repository. - -Problem Description -=================== - -Sphinx toctree complains if no file exists in a directory -specified in toctree glob. - -Proposed Change -=============== - -Add this file. - -References -========== - -None. diff --git a/specs/rocky/index.rst b/specs/rocky/index.rst new file mode 100644 index 000000000..a161de94b --- /dev/null +++ b/specs/rocky/index.rst @@ -0,0 +1,9 @@ +===== +Rocky +===== + +.. toctree:: + :glob: + :maxdepth: 1 + + * diff --git a/specs/stadium/index.rst b/specs/stadium/index.rst new file mode 100644 index 000000000..038bb0e53 --- /dev/null +++ b/specs/stadium/index.rst @@ -0,0 +1,11 @@ +============== +Stadium Health +============== + +.. toctree:: + :glob: + :maxdepth: 1 + + Queens + Pike + Ocata diff --git a/specs/stadium/ocata.rst b/specs/stadium/ocata/index.rst similarity index 87% rename from specs/stadium/ocata.rst rename to specs/stadium/ocata/index.rst index 0a7f5b2da..f4d58e461 100644 --- a/specs/stadium/ocata.rst +++ b/specs/stadium/ocata/index.rst @@ -37,14 +37,14 @@ that artifacts in the periodic output shows at least one successful run. Assessment ++++++++++ - * networking-bagpipe: OK. - * networking-odl: OK. - * networking-bgpvpn: OK. - * networking-midonet: OK. - * neutron-dynamic-routing: OK. - * neutron-fwaas: OK. - * networking-ovn: OK. - * networking-sfc: OK. +* networking-bagpipe: OK. +* networking-odl: OK. +* networking-bgpvpn: OK. +* networking-midonet: OK. +* neutron-dynamic-routing: OK. +* neutron-fwaas: OK. +* networking-ovn: OK. +* networking-sfc: OK. .. _Docs: @@ -67,14 +67,14 @@ notes for the latest release (Newton). Check for a working link to API reference Assessment ++++++++++ - * networking-bagpipe: OK. - * networking-odl: OK. - * networking-bgpvpn: needs API documentation. - * networking-midonet: needs API documentation. - * neutron-dynamic-routing: needs API documentation. - * neutron-fwaas: OK. - * networking-ovn: OK. - * networking-sfc: needs API documentation. +* networking-bagpipe: OK. +* networking-odl: OK. +* networking-bgpvpn: needs API documentation. +* networking-midonet: needs API documentation. +* neutron-dynamic-routing: needs API documentation. +* neutron-fwaas: OK. +* networking-ovn: OK. +* networking-sfc: needs API documentation. .. _CI: @@ -98,14 +98,14 @@ gating tempest tests. Check for scenario tests. Check for DB migration tests. Assessment ++++++++++ - * networking-bagpipe: OK. - * networking-odl: OK. - * networking-bgpvpn: OK. - * networking-midonet: OK. - * neutron-dynamic-routing: needs scenario tests. Needs DB/sync validation. - * neutron-fwaas: OK. - * networking-ovn: OK. - * networking-sfc: OK. +* networking-bagpipe: OK. +* networking-odl: OK. +* networking-bgpvpn: OK. +* networking-midonet: OK. +* neutron-dynamic-routing: needs scenario tests. Needs DB/sync validation. +* neutron-fwaas: OK. +* networking-ovn: OK. +* networking-sfc: OK. .. _Release: @@ -131,14 +131,14 @@ upper-constraints. Assessment ++++++++++ - * networking-bagpipe: OK. - * networking-odl: OK. - * networking-bgpvpn: OK. - * networking-midonet: OK. - * neutron-dynamic-routing: OK. - * neutron-fwaas: OK. - * networking-ovn: OK. - * networking-sfc: OK. +* networking-bagpipe: OK. +* networking-odl: OK. +* networking-bgpvpn: OK. +* networking-midonet: OK. +* neutron-dynamic-routing: OK. +* neutron-fwaas: OK. +* networking-ovn: OK. +* networking-sfc: OK. .. _Maintenance: @@ -159,14 +159,14 @@ to the right branch. Assessment ++++++++++ - * networking-bagpipe: OK. - * networking-odl: OK. - * networking-bgpvpn: OK. - * networking-midonet: OK. - * neutron-dynamic-routing: OK. - * neutron-fwaas: OK. - * networking-ovn: OK. - * networking-sfc: OK. +* networking-bagpipe: OK. +* networking-odl: OK. +* networking-bgpvpn: OK. +* networking-midonet: OK. +* neutron-dynamic-routing: OK. +* neutron-fwaas: OK. +* networking-ovn: OK. +* networking-sfc: OK. .. _CLI: @@ -186,14 +186,14 @@ Check for presence of OSC bindings in python-neutronclient. Assessment ++++++++++ - * networking-bagpipe: N/A. - * networking-odl: N/A. - * networking-bgpvpn: needs porting to python-neutronclient. - * networking-midonet: needs porting to python-neutronclient. - * neutron-dynamic-routing: needs porting to python-neutronclient. - * neutron-fwaas: OK. - * networking-ovn: N/A. - * networking-sfc: needs porting to python-neutronclient. +* networking-bagpipe: N/A. +* networking-odl: N/A. +* networking-bgpvpn: needs porting to python-neutronclient. +* networking-midonet: needs porting to python-neutronclient. +* neutron-dynamic-routing: needs porting to python-neutronclient. +* neutron-fwaas: OK. +* networking-ovn: N/A. +* networking-sfc: needs porting to python-neutronclient. Summary ======= @@ -228,6 +228,15 @@ Summary (*) To re-apply for inclusion in Pike or future releases. +Scorecards +========== + +.. toctree:: + :glob: + :maxdepth: 1 + + * + How Reconcile API and client bindings ===================================== diff --git a/specs/stadium/pike.rst b/specs/stadium/pike/index.rst similarity index 94% rename from specs/stadium/pike.rst rename to specs/stadium/pike/index.rst index e9293c2e1..2b1578812 100644 --- a/specs/stadium/pike.rst +++ b/specs/stadium/pike/index.rst @@ -29,3 +29,12 @@ Summary +===================================================================+===============+===============+===============+===============+===============+===============+ | `placeholder <./pike/placeholder.html>`_ | TBD | TBD | TBD | TBD | TBD | TBD | +-------------------------------------------------------------------+---------------+---------------+---------------+---------------+---------------+---------------+ + +Scorecards +========== + +.. toctree:: + :glob: + :maxdepth: 1 + + * diff --git a/specs/stadium/queens.rst b/specs/stadium/queens/index.rst similarity index 94% rename from specs/stadium/queens.rst rename to specs/stadium/queens/index.rst index cb6cbfcd4..69efc7f96 100644 --- a/specs/stadium/queens.rst +++ b/specs/stadium/queens/index.rst @@ -29,3 +29,12 @@ Summary +===================================================================+===============+===============+===============+===============+===============+===============+ | `placeholder <./queens/placeholder.html>`_ | TBD | TBD | TBD | TBD | TBD | TBD | +-------------------------------------------------------------------+---------------+---------------+---------------+---------------+---------------+---------------+ + +Scorecards +========== + +.. toctree:: + :glob: + :maxdepth: 1 + + *