Merge "Reorganize docs to fit openstackdocstheme"
This commit is contained in:
commit
d06a992d18
doc/source
specs
backlog
juno
kilo
liberty
mitaka
newton
ocata
pike
queens
rocky
stadium
@ -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
|
||||
|
@ -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 <specs/ocata/postmortem/postmortem>
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
Newton
|
||||
======
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Postmortem documentation <specs/newton/postmortem/postmortem>
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
specs/newton/*
|
||||
|
||||
Mitaka
|
||||
======
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Postmortem documentation <specs/mitaka/postmortem/postmortem>
|
||||
|
||||
.. 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`
|
||||
|
9
specs/backlog/index.rst
Normal file
9
specs/backlog/index.rst
Normal file
@ -0,0 +1,9 @@
|
||||
=======
|
||||
Backlog
|
||||
=======
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
**
|
9
specs/juno/index.rst
Normal file
9
specs/juno/index.rst
Normal file
@ -0,0 +1,9 @@
|
||||
====
|
||||
Juno
|
||||
====
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
*
|
9
specs/kilo/index.rst
Normal file
9
specs/kilo/index.rst
Normal file
@ -0,0 +1,9 @@
|
||||
====
|
||||
Kilo
|
||||
====
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
*
|
9
specs/liberty/index.rst
Normal file
9
specs/liberty/index.rst
Normal file
@ -0,0 +1,9 @@
|
||||
=======
|
||||
Liberty
|
||||
=======
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
*
|
14
specs/mitaka/index.rst
Normal file
14
specs/mitaka/index.rst
Normal file
@ -0,0 +1,14 @@
|
||||
======
|
||||
Mitaka
|
||||
======
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
[Postmortem] <postmortem/postmortem>
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
*
|
@ -4,8 +4,8 @@
|
||||
|
||||
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||
|
||||
Postmortem documentation
|
||||
========================
|
||||
Mitaka Postmortem documentation
|
||||
===============================
|
||||
|
||||
.. contents::
|
||||
|
||||
|
14
specs/newton/index.rst
Normal file
14
specs/newton/index.rst
Normal file
@ -0,0 +1,14 @@
|
||||
======
|
||||
Newton
|
||||
======
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
[Postmortem] <postmortem/postmortem>
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
*
|
@ -4,8 +4,8 @@
|
||||
|
||||
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||
|
||||
Postmortem documentation
|
||||
========================
|
||||
Newton Postmortem documentation
|
||||
===============================
|
||||
|
||||
.. contents::
|
||||
|
||||
|
8
specs/ocata/index.rst
Normal file
8
specs/ocata/index.rst
Normal file
@ -0,0 +1,8 @@
|
||||
=====
|
||||
Ocata
|
||||
=====
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
[Postmortem] <postmortem/postmortem>
|
@ -4,8 +4,8 @@
|
||||
|
||||
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||
|
||||
Postmortem documentation
|
||||
========================
|
||||
Ocata Postmortem documentation
|
||||
==============================
|
||||
|
||||
.. contents::
|
||||
|
||||
|
9
specs/pike/index.rst
Normal file
9
specs/pike/index.rst
Normal file
@ -0,0 +1,9 @@
|
||||
====
|
||||
Pike
|
||||
====
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
*
|
5
specs/queens/index.rst
Normal file
5
specs/queens/index.rst
Normal file
@ -0,0 +1,5 @@
|
||||
======
|
||||
Queens
|
||||
======
|
||||
|
||||
No spec document landed.
|
@ -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.
|
9
specs/rocky/index.rst
Normal file
9
specs/rocky/index.rst
Normal file
@ -0,0 +1,9 @@
|
||||
=====
|
||||
Rocky
|
||||
=====
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
*
|
11
specs/stadium/index.rst
Normal file
11
specs/stadium/index.rst
Normal file
@ -0,0 +1,11 @@
|
||||
==============
|
||||
Stadium Health
|
||||
==============
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
Queens <queens/index>
|
||||
Pike <pike/index>
|
||||
Ocata <ocata/index>
|
@ -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
|
||||
=====================================
|
||||
|
@ -29,3 +29,12 @@ Summary
|
||||
+===================================================================+===============+===============+===============+===============+===============+===============+
|
||||
| `placeholder <./pike/placeholder.html>`_ | TBD | TBD | TBD | TBD | TBD | TBD |
|
||||
+-------------------------------------------------------------------+---------------+---------------+---------------+---------------+---------------+---------------+
|
||||
|
||||
Scorecards
|
||||
==========
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
*
|
@ -29,3 +29,12 @@ Summary
|
||||
+===================================================================+===============+===============+===============+===============+===============+===============+
|
||||
| `placeholder <./queens/placeholder.html>`_ | TBD | TBD | TBD | TBD | TBD | TBD |
|
||||
+-------------------------------------------------------------------+---------------+---------------+---------------+---------------+---------------+---------------+
|
||||
|
||||
Scorecards
|
||||
==========
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
*
|
Loading…
x
Reference in New Issue
Block a user