Rearrange existing documentation to fit the new standard layout

For more detail, see the doc migration spec.
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Change-Id: I142a686a3abbe65138a9f3296cd21fc21fbd763a
This commit is contained in:
Akihiro Motoki 2017-07-06 06:31:21 +09:00
parent f04c6181e5
commit 2a47ffd96d
74 changed files with 56 additions and 46 deletions

View File

@ -23,9 +23,28 @@
''''''' Heading 4 ''''''' Heading 4
(Avoid deeper levels because they do not render well.) (Avoid deeper levels because they do not render well.)
=================
Contributor Guide
=================
Neutron Policies
----------------
.. toctree::
:maxdepth: 2
policies/index
Neutron Stadium
---------------
.. toctree::
:maxdepth: 2
stadium/index
Developer Guide Developer Guide
=============== ---------------
In the Developer Guide, you will find information on Neutron's lower level In the Developer Guide, you will find information on Neutron's lower level
programming APIs. There are sections that cover the core pieces of Neutron, programming APIs. There are sections that cover the core pieces of Neutron,
@ -34,12 +53,32 @@ also subsections that describe specific plugins inside Neutron. Finally,
the developer guide includes information about Neutron testing infrastructure. the developer guide includes information about Neutron testing infrastructure.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
effective_neutron effective_neutron
development.environment development_environment
contribute contribute
neutron_api neutron_api
client_command_extensions client_command_extensions
alembic_migrations alembic_migrations
modules testing/index
Neutron Internals
-----------------
.. toctree::
:maxdepth: 2
internals/index
modules
Dashboards
----------
There is a collection of dashboards to help developers and reviewers
located here.
.. toctree::
:maxdepth: 2
dashboards/index

View File

Before

Width:  |  Height:  |  Size: 110 KiB

After

Width:  |  Height:  |  Size: 110 KiB

View File

Before

Width:  |  Height:  |  Size: 116 KiB

After

Width:  |  Height:  |  Size: 116 KiB

View File

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 31 KiB

View File

@ -31,7 +31,7 @@ Testing
:maxdepth: 2 :maxdepth: 2
testing testing
fullstack_testing fullstack
testing_coverage coverage
template_model_sync_test template_model_sync_test
db_transient_failure_injection db_transient_failure_injection

View File

@ -23,4 +23,4 @@
''''''' Heading 4 ''''''' Heading 4
(Avoid deeper levels because they do not render well.) (Avoid deeper levels because they do not render well.)
.. include:: ../../../TESTING.rst .. include:: ../../../../TESTING.rst

View File

@ -14,8 +14,8 @@
License for the specific language governing permissions and limitations License for the specific language governing permissions and limitations
under the License. under the License.
Welcome to Neutron's developer documentation! Welcome to Neutron's documentation!
============================================= ===================================
Neutron is an OpenStack project to provide "network connectivity as a service" Neutron is an OpenStack project to provide "network connectivity as a service"
between interface devices (e.g., vNICs) managed by other OpenStack services between interface devices (e.g., vNICs) managed by other OpenStack services
@ -47,22 +47,6 @@ Networking Guide
admin/index admin/index
Neutron Policies
----------------
.. toctree::
:maxdepth: 2
policies/index
Neutron Stadium
----------------
.. toctree::
:maxdepth: 2
stadium/index
Neutron Feature Classification Neutron Feature Classification
------------------------------ ------------------------------
@ -71,26 +55,13 @@ Neutron Feature Classification
feature_classification/index feature_classification/index
Developer Docs Contributor Guide
-------------- -----------------
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
devref/index contributor/index
devref/testing_index
devref/neutron_internals
Dashboards
----------
There is a collection of dashboards to help developers and reviewers
located here.
.. toctree::
:maxdepth: 2
dashboards/index
API Extensions API Extensions
-------------- --------------