Merge "Rearrange existing documentation to fit the new standard layout"
This commit is contained in:
commit
a51271d760
doc/source
contributor
alembic_migrations.rstclient_command_extensions.rstcontribute.rst
index.rstdashboards
development_environment.rsteffective_neutron.rstindex.rstinternals
address_scopes.rstagent_extensions.rstapi_extensions.rstapi_layer.rstcalling_ml2_plugin.rstdb_layer.rstdb_models.rstdns_order.rstexternal_dns_integration.rsti18n.rst
modules.rstneutron_api.rstimages
live-mig-ovs-hybrid.pnglive-mig-ovs-hybrid.txtlive-mig.pnglive-mig.txtunder-the-hood-scenario-1-ovs-compute.pngunder-the-hood-scenario-1-ovs-netns.pngunder-the-hood-scenario-1-ovs-network.png
index.rstl2_agent_extensions.rstl2_agents.rstl3_agent_extensions.rstlayer3.rstlinuxbridge_agent.rstlive_migration.rstml2_ext_manager.rstnetwork_ip_availability.rstobjects_usage.rstopenvswitch_agent.rstopenvswitch_firewall.rstovs_vhostuser.rstplugin-api.rstpolicy.rstprovisioning_blocks.rstquality_of_service.rstquota.rstretries.rstrpc_api.rstrpc_callbacks.rstsecurity_group_api.rstservice_extensions.rstservices_and_agents.rstsriov_nic_agent.rsttag.rstupgrade.rstpolicies
blueprints.rstbugs.rstcode-reviews.rstcontributor-onboarding.rstgate-failure-triage.rstgerrit-recheck.rstindex.rstneutron-teams.rstrelease-checklist.rstthirdparty-ci.rst
stadium
testing
0
doc/source/devref/development.environment.rst → doc/source/contributor/development_environment.rst
0
doc/source/devref/development.environment.rst → doc/source/contributor/development_environment.rst
@ -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
|
0
doc/source/devref/calling_ml2_plugin.rst → doc/source/contributor/internals/calling_ml2_plugin.rst
0
doc/source/devref/calling_ml2_plugin.rst → doc/source/contributor/internals/calling_ml2_plugin.rst
Before ![]() (image error) Size: 110 KiB After ![]() (image error) Size: 110 KiB ![]() ![]() |
Before ![]() (image error) Size: 116 KiB After ![]() (image error) Size: 116 KiB ![]() ![]() |
Before ![]() (image error) Size: 198 KiB After ![]() (image error) Size: 198 KiB ![]() ![]() |
Before ![]() (image error) Size: 83 KiB After ![]() (image error) Size: 83 KiB ![]() ![]() |
Before ![]() (image error) Size: 162 KiB After ![]() (image error) Size: 162 KiB ![]() ![]() |
0
doc/source/devref/l2_agent_extensions.rst → doc/source/contributor/internals/l2_agent_extensions.rst
0
doc/source/devref/l2_agent_extensions.rst → doc/source/contributor/internals/l2_agent_extensions.rst
0
doc/source/devref/l3_agent_extensions.rst → doc/source/contributor/internals/l3_agent_extensions.rst
0
doc/source/devref/l3_agent_extensions.rst → doc/source/contributor/internals/l3_agent_extensions.rst
0
doc/source/devref/provisioning_blocks.rst → doc/source/contributor/internals/provisioning_blocks.rst
0
doc/source/devref/provisioning_blocks.rst → doc/source/contributor/internals/provisioning_blocks.rst
0
doc/source/devref/quality_of_service.rst → doc/source/contributor/internals/quality_of_service.rst
0
doc/source/devref/quality_of_service.rst → doc/source/contributor/internals/quality_of_service.rst
0
doc/source/devref/security_group_api.rst → doc/source/contributor/internals/security_group_api.rst
0
doc/source/devref/security_group_api.rst → doc/source/contributor/internals/security_group_api.rst
0
doc/source/devref/service_extensions.rst → doc/source/contributor/internals/service_extensions.rst
0
doc/source/devref/service_extensions.rst → doc/source/contributor/internals/service_extensions.rst
0
doc/source/devref/services_and_agents.rst → doc/source/contributor/internals/services_and_agents.rst
0
doc/source/devref/services_and_agents.rst → doc/source/contributor/internals/services_and_agents.rst
Before ![]() (image error) Size: 31 KiB After ![]() (image error) Size: 31 KiB ![]() ![]() |
@ -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
|
@ -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
|
@ -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
|
||||||
@ -55,22 +55,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
|
||||||
------------------------------
|
------------------------------
|
||||||
|
|
||||||
@ -79,26 +63,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
|
||||||
--------------
|
--------------
|
||||||
|
Loading…
x
Reference in New Issue
Block a user