diff --git a/doc/source/devref/alembic_migrations.rst b/doc/source/contributor/alembic_migrations.rst similarity index 100% rename from doc/source/devref/alembic_migrations.rst rename to doc/source/contributor/alembic_migrations.rst diff --git a/doc/source/devref/client_command_extensions.rst b/doc/source/contributor/client_command_extensions.rst similarity index 100% rename from doc/source/devref/client_command_extensions.rst rename to doc/source/contributor/client_command_extensions.rst diff --git a/doc/source/devref/contribute.rst b/doc/source/contributor/contribute.rst similarity index 100% rename from doc/source/devref/contribute.rst rename to doc/source/contributor/contribute.rst diff --git a/doc/source/dashboards/index.rst b/doc/source/contributor/dashboards/index.rst similarity index 100% rename from doc/source/dashboards/index.rst rename to doc/source/contributor/dashboards/index.rst diff --git a/doc/source/devref/development.environment.rst b/doc/source/contributor/development_environment.rst similarity index 100% rename from doc/source/devref/development.environment.rst rename to doc/source/contributor/development_environment.rst diff --git a/doc/source/devref/effective_neutron.rst b/doc/source/contributor/effective_neutron.rst similarity index 100% rename from doc/source/devref/effective_neutron.rst rename to doc/source/contributor/effective_neutron.rst diff --git a/doc/source/devref/index.rst b/doc/source/contributor/index.rst similarity index 68% rename from doc/source/devref/index.rst rename to doc/source/contributor/index.rst index a860785f40a..62878949b10 100644 --- a/doc/source/devref/index.rst +++ b/doc/source/contributor/index.rst @@ -23,9 +23,28 @@ ''''''' Heading 4 (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 -=============== +--------------- 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, @@ -34,12 +53,32 @@ also subsections that describe specific plugins inside Neutron. Finally, the developer guide includes information about Neutron testing infrastructure. .. toctree:: - :maxdepth: 2 + :maxdepth: 2 - effective_neutron - development.environment - contribute - neutron_api - client_command_extensions - alembic_migrations - modules + effective_neutron + development_environment + contribute + neutron_api + client_command_extensions + alembic_migrations + 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 diff --git a/doc/source/devref/address_scopes.rst b/doc/source/contributor/internals/address_scopes.rst similarity index 100% rename from doc/source/devref/address_scopes.rst rename to doc/source/contributor/internals/address_scopes.rst diff --git a/doc/source/devref/agent_extensions.rst b/doc/source/contributor/internals/agent_extensions.rst similarity index 100% rename from doc/source/devref/agent_extensions.rst rename to doc/source/contributor/internals/agent_extensions.rst diff --git a/doc/source/devref/api_extensions.rst b/doc/source/contributor/internals/api_extensions.rst similarity index 100% rename from doc/source/devref/api_extensions.rst rename to doc/source/contributor/internals/api_extensions.rst diff --git a/doc/source/devref/api_layer.rst b/doc/source/contributor/internals/api_layer.rst similarity index 100% rename from doc/source/devref/api_layer.rst rename to doc/source/contributor/internals/api_layer.rst diff --git a/doc/source/devref/calling_ml2_plugin.rst b/doc/source/contributor/internals/calling_ml2_plugin.rst similarity index 100% rename from doc/source/devref/calling_ml2_plugin.rst rename to doc/source/contributor/internals/calling_ml2_plugin.rst diff --git a/doc/source/devref/db_layer.rst b/doc/source/contributor/internals/db_layer.rst similarity index 100% rename from doc/source/devref/db_layer.rst rename to doc/source/contributor/internals/db_layer.rst diff --git a/doc/source/devref/db_models.rst b/doc/source/contributor/internals/db_models.rst similarity index 100% rename from doc/source/devref/db_models.rst rename to doc/source/contributor/internals/db_models.rst diff --git a/doc/source/devref/dns_order.rst b/doc/source/contributor/internals/dns_order.rst similarity index 100% rename from doc/source/devref/dns_order.rst rename to doc/source/contributor/internals/dns_order.rst diff --git a/doc/source/devref/external_dns_integration.rst b/doc/source/contributor/internals/external_dns_integration.rst similarity index 100% rename from doc/source/devref/external_dns_integration.rst rename to doc/source/contributor/internals/external_dns_integration.rst diff --git a/doc/source/devref/i18n.rst b/doc/source/contributor/internals/i18n.rst similarity index 100% rename from doc/source/devref/i18n.rst rename to doc/source/contributor/internals/i18n.rst diff --git a/doc/source/devref/images/live-mig-ovs-hybrid.png b/doc/source/contributor/internals/images/live-mig-ovs-hybrid.png similarity index 100% rename from doc/source/devref/images/live-mig-ovs-hybrid.png rename to doc/source/contributor/internals/images/live-mig-ovs-hybrid.png diff --git a/doc/source/devref/images/live-mig-ovs-hybrid.txt b/doc/source/contributor/internals/images/live-mig-ovs-hybrid.txt similarity index 100% rename from doc/source/devref/images/live-mig-ovs-hybrid.txt rename to doc/source/contributor/internals/images/live-mig-ovs-hybrid.txt diff --git a/doc/source/devref/images/live-mig.png b/doc/source/contributor/internals/images/live-mig.png similarity index 100% rename from doc/source/devref/images/live-mig.png rename to doc/source/contributor/internals/images/live-mig.png diff --git a/doc/source/devref/images/live-mig.txt b/doc/source/contributor/internals/images/live-mig.txt similarity index 100% rename from doc/source/devref/images/live-mig.txt rename to doc/source/contributor/internals/images/live-mig.txt diff --git a/doc/source/devref/images/under-the-hood-scenario-1-ovs-compute.png b/doc/source/contributor/internals/images/under-the-hood-scenario-1-ovs-compute.png similarity index 100% rename from doc/source/devref/images/under-the-hood-scenario-1-ovs-compute.png rename to doc/source/contributor/internals/images/under-the-hood-scenario-1-ovs-compute.png diff --git a/doc/source/devref/images/under-the-hood-scenario-1-ovs-netns.png b/doc/source/contributor/internals/images/under-the-hood-scenario-1-ovs-netns.png similarity index 100% rename from doc/source/devref/images/under-the-hood-scenario-1-ovs-netns.png rename to doc/source/contributor/internals/images/under-the-hood-scenario-1-ovs-netns.png diff --git a/doc/source/devref/images/under-the-hood-scenario-1-ovs-network.png b/doc/source/contributor/internals/images/under-the-hood-scenario-1-ovs-network.png similarity index 100% rename from doc/source/devref/images/under-the-hood-scenario-1-ovs-network.png rename to doc/source/contributor/internals/images/under-the-hood-scenario-1-ovs-network.png diff --git a/doc/source/devref/neutron_internals.rst b/doc/source/contributor/internals/index.rst similarity index 100% rename from doc/source/devref/neutron_internals.rst rename to doc/source/contributor/internals/index.rst diff --git a/doc/source/devref/l2_agent_extensions.rst b/doc/source/contributor/internals/l2_agent_extensions.rst similarity index 100% rename from doc/source/devref/l2_agent_extensions.rst rename to doc/source/contributor/internals/l2_agent_extensions.rst diff --git a/doc/source/devref/l2_agents.rst b/doc/source/contributor/internals/l2_agents.rst similarity index 100% rename from doc/source/devref/l2_agents.rst rename to doc/source/contributor/internals/l2_agents.rst diff --git a/doc/source/devref/l3_agent_extensions.rst b/doc/source/contributor/internals/l3_agent_extensions.rst similarity index 100% rename from doc/source/devref/l3_agent_extensions.rst rename to doc/source/contributor/internals/l3_agent_extensions.rst diff --git a/doc/source/devref/layer3.rst b/doc/source/contributor/internals/layer3.rst similarity index 100% rename from doc/source/devref/layer3.rst rename to doc/source/contributor/internals/layer3.rst diff --git a/doc/source/devref/linuxbridge_agent.rst b/doc/source/contributor/internals/linuxbridge_agent.rst similarity index 100% rename from doc/source/devref/linuxbridge_agent.rst rename to doc/source/contributor/internals/linuxbridge_agent.rst diff --git a/doc/source/devref/live_migration.rst b/doc/source/contributor/internals/live_migration.rst similarity index 100% rename from doc/source/devref/live_migration.rst rename to doc/source/contributor/internals/live_migration.rst diff --git a/doc/source/devref/ml2_ext_manager.rst b/doc/source/contributor/internals/ml2_ext_manager.rst similarity index 100% rename from doc/source/devref/ml2_ext_manager.rst rename to doc/source/contributor/internals/ml2_ext_manager.rst diff --git a/doc/source/devref/network_ip_availability.rst b/doc/source/contributor/internals/network_ip_availability.rst similarity index 100% rename from doc/source/devref/network_ip_availability.rst rename to doc/source/contributor/internals/network_ip_availability.rst diff --git a/doc/source/devref/objects_usage.rst b/doc/source/contributor/internals/objects_usage.rst similarity index 100% rename from doc/source/devref/objects_usage.rst rename to doc/source/contributor/internals/objects_usage.rst diff --git a/doc/source/devref/openvswitch_agent.rst b/doc/source/contributor/internals/openvswitch_agent.rst similarity index 100% rename from doc/source/devref/openvswitch_agent.rst rename to doc/source/contributor/internals/openvswitch_agent.rst diff --git a/doc/source/devref/openvswitch_firewall.rst b/doc/source/contributor/internals/openvswitch_firewall.rst similarity index 100% rename from doc/source/devref/openvswitch_firewall.rst rename to doc/source/contributor/internals/openvswitch_firewall.rst diff --git a/doc/source/devref/ovs_vhostuser.rst b/doc/source/contributor/internals/ovs_vhostuser.rst similarity index 100% rename from doc/source/devref/ovs_vhostuser.rst rename to doc/source/contributor/internals/ovs_vhostuser.rst diff --git a/doc/source/devref/plugin-api.rst b/doc/source/contributor/internals/plugin-api.rst similarity index 100% rename from doc/source/devref/plugin-api.rst rename to doc/source/contributor/internals/plugin-api.rst diff --git a/doc/source/devref/policy.rst b/doc/source/contributor/internals/policy.rst similarity index 100% rename from doc/source/devref/policy.rst rename to doc/source/contributor/internals/policy.rst diff --git a/doc/source/devref/provisioning_blocks.rst b/doc/source/contributor/internals/provisioning_blocks.rst similarity index 100% rename from doc/source/devref/provisioning_blocks.rst rename to doc/source/contributor/internals/provisioning_blocks.rst diff --git a/doc/source/devref/quality_of_service.rst b/doc/source/contributor/internals/quality_of_service.rst similarity index 100% rename from doc/source/devref/quality_of_service.rst rename to doc/source/contributor/internals/quality_of_service.rst diff --git a/doc/source/devref/quota.rst b/doc/source/contributor/internals/quota.rst similarity index 100% rename from doc/source/devref/quota.rst rename to doc/source/contributor/internals/quota.rst diff --git a/doc/source/devref/retries.rst b/doc/source/contributor/internals/retries.rst similarity index 100% rename from doc/source/devref/retries.rst rename to doc/source/contributor/internals/retries.rst diff --git a/doc/source/devref/rpc_api.rst b/doc/source/contributor/internals/rpc_api.rst similarity index 100% rename from doc/source/devref/rpc_api.rst rename to doc/source/contributor/internals/rpc_api.rst diff --git a/doc/source/devref/rpc_callbacks.rst b/doc/source/contributor/internals/rpc_callbacks.rst similarity index 100% rename from doc/source/devref/rpc_callbacks.rst rename to doc/source/contributor/internals/rpc_callbacks.rst diff --git a/doc/source/devref/security_group_api.rst b/doc/source/contributor/internals/security_group_api.rst similarity index 100% rename from doc/source/devref/security_group_api.rst rename to doc/source/contributor/internals/security_group_api.rst diff --git a/doc/source/devref/service_extensions.rst b/doc/source/contributor/internals/service_extensions.rst similarity index 100% rename from doc/source/devref/service_extensions.rst rename to doc/source/contributor/internals/service_extensions.rst diff --git a/doc/source/devref/services_and_agents.rst b/doc/source/contributor/internals/services_and_agents.rst similarity index 100% rename from doc/source/devref/services_and_agents.rst rename to doc/source/contributor/internals/services_and_agents.rst diff --git a/doc/source/devref/sriov_nic_agent.rst b/doc/source/contributor/internals/sriov_nic_agent.rst similarity index 100% rename from doc/source/devref/sriov_nic_agent.rst rename to doc/source/contributor/internals/sriov_nic_agent.rst diff --git a/doc/source/devref/tag.rst b/doc/source/contributor/internals/tag.rst similarity index 100% rename from doc/source/devref/tag.rst rename to doc/source/contributor/internals/tag.rst diff --git a/doc/source/devref/upgrade.rst b/doc/source/contributor/internals/upgrade.rst similarity index 100% rename from doc/source/devref/upgrade.rst rename to doc/source/contributor/internals/upgrade.rst diff --git a/doc/source/devref/modules.rst b/doc/source/contributor/modules.rst similarity index 100% rename from doc/source/devref/modules.rst rename to doc/source/contributor/modules.rst diff --git a/doc/source/devref/neutron_api.rst b/doc/source/contributor/neutron_api.rst similarity index 100% rename from doc/source/devref/neutron_api.rst rename to doc/source/contributor/neutron_api.rst diff --git a/doc/source/policies/blueprints.rst b/doc/source/contributor/policies/blueprints.rst similarity index 100% rename from doc/source/policies/blueprints.rst rename to doc/source/contributor/policies/blueprints.rst diff --git a/doc/source/policies/bugs.rst b/doc/source/contributor/policies/bugs.rst similarity index 100% rename from doc/source/policies/bugs.rst rename to doc/source/contributor/policies/bugs.rst diff --git a/doc/source/policies/code-reviews.rst b/doc/source/contributor/policies/code-reviews.rst similarity index 100% rename from doc/source/policies/code-reviews.rst rename to doc/source/contributor/policies/code-reviews.rst diff --git a/doc/source/policies/contributor-onboarding.rst b/doc/source/contributor/policies/contributor-onboarding.rst similarity index 100% rename from doc/source/policies/contributor-onboarding.rst rename to doc/source/contributor/policies/contributor-onboarding.rst diff --git a/doc/source/policies/gate-failure-triage.rst b/doc/source/contributor/policies/gate-failure-triage.rst similarity index 100% rename from doc/source/policies/gate-failure-triage.rst rename to doc/source/contributor/policies/gate-failure-triage.rst diff --git a/doc/source/policies/gerrit-recheck.rst b/doc/source/contributor/policies/gerrit-recheck.rst similarity index 100% rename from doc/source/policies/gerrit-recheck.rst rename to doc/source/contributor/policies/gerrit-recheck.rst diff --git a/doc/source/policies/index.rst b/doc/source/contributor/policies/index.rst similarity index 100% rename from doc/source/policies/index.rst rename to doc/source/contributor/policies/index.rst diff --git a/doc/source/policies/neutron-teams.rst b/doc/source/contributor/policies/neutron-teams.rst similarity index 100% rename from doc/source/policies/neutron-teams.rst rename to doc/source/contributor/policies/neutron-teams.rst diff --git a/doc/source/policies/release-checklist.rst b/doc/source/contributor/policies/release-checklist.rst similarity index 100% rename from doc/source/policies/release-checklist.rst rename to doc/source/contributor/policies/release-checklist.rst diff --git a/doc/source/policies/thirdparty-ci.rst b/doc/source/contributor/policies/thirdparty-ci.rst similarity index 100% rename from doc/source/policies/thirdparty-ci.rst rename to doc/source/contributor/policies/thirdparty-ci.rst diff --git a/doc/source/stadium/governance.rst b/doc/source/contributor/stadium/governance.rst similarity index 100% rename from doc/source/stadium/governance.rst rename to doc/source/contributor/stadium/governance.rst diff --git a/doc/source/stadium/guidelines.rst b/doc/source/contributor/stadium/guidelines.rst similarity index 100% rename from doc/source/stadium/guidelines.rst rename to doc/source/contributor/stadium/guidelines.rst diff --git a/doc/source/stadium/index.rst b/doc/source/contributor/stadium/index.rst similarity index 100% rename from doc/source/stadium/index.rst rename to doc/source/contributor/stadium/index.rst diff --git a/doc/source/devref/testing_coverage.rst b/doc/source/contributor/testing/coverage.rst similarity index 100% rename from doc/source/devref/testing_coverage.rst rename to doc/source/contributor/testing/coverage.rst diff --git a/doc/source/devref/db_transient_failure_injection.rst b/doc/source/contributor/testing/db_transient_failure_injection.rst similarity index 100% rename from doc/source/devref/db_transient_failure_injection.rst rename to doc/source/contributor/testing/db_transient_failure_injection.rst diff --git a/doc/source/devref/fullstack_testing.rst b/doc/source/contributor/testing/fullstack.rst similarity index 100% rename from doc/source/devref/fullstack_testing.rst rename to doc/source/contributor/testing/fullstack.rst diff --git a/doc/source/devref/images/fullstack_multinode_simulation.png b/doc/source/contributor/testing/images/fullstack_multinode_simulation.png similarity index 100% rename from doc/source/devref/images/fullstack_multinode_simulation.png rename to doc/source/contributor/testing/images/fullstack_multinode_simulation.png diff --git a/doc/source/devref/testing_index.rst b/doc/source/contributor/testing/index.rst similarity index 96% rename from doc/source/devref/testing_index.rst rename to doc/source/contributor/testing/index.rst index 64a52aba1ca..06d8839d0ac 100644 --- a/doc/source/devref/testing_index.rst +++ b/doc/source/contributor/testing/index.rst @@ -31,7 +31,7 @@ Testing :maxdepth: 2 testing - fullstack_testing - testing_coverage + fullstack + coverage template_model_sync_test db_transient_failure_injection diff --git a/doc/source/devref/template_model_sync_test.rst b/doc/source/contributor/testing/template_model_sync_test.rst similarity index 100% rename from doc/source/devref/template_model_sync_test.rst rename to doc/source/contributor/testing/template_model_sync_test.rst diff --git a/doc/source/devref/testing.rst b/doc/source/contributor/testing/testing.rst similarity index 96% rename from doc/source/devref/testing.rst rename to doc/source/contributor/testing/testing.rst index 340374413e1..d06addbb6b6 100644 --- a/doc/source/devref/testing.rst +++ b/doc/source/contributor/testing/testing.rst @@ -23,4 +23,4 @@ ''''''' Heading 4 (Avoid deeper levels because they do not render well.) -.. include:: ../../../TESTING.rst +.. include:: ../../../../TESTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 1de4c42eac3..a9b04863693 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -14,8 +14,8 @@ License for the specific language governing permissions and limitations 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" between interface devices (e.g., vNICs) managed by other OpenStack services @@ -47,22 +47,6 @@ Networking Guide admin/index -Neutron Policies ----------------- - -.. toctree:: - :maxdepth: 2 - - policies/index - -Neutron Stadium ----------------- - -.. toctree:: - :maxdepth: 2 - - stadium/index - Neutron Feature Classification ------------------------------ @@ -71,26 +55,13 @@ Neutron Feature Classification feature_classification/index -Developer Docs --------------- +Contributor Guide +----------------- .. toctree:: :maxdepth: 2 - devref/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 + contributor/index API Extensions --------------