Browse Source

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
Akihiro Motoki 1 year ago
parent
commit
2a47ffd96d
74 changed files with 57 additions and 47 deletions
  1. 0
    0
      doc/source/contributor/alembic_migrations.rst
  2. 0
    0
      doc/source/contributor/client_command_extensions.rst
  3. 0
    0
      doc/source/contributor/contribute.rst
  4. 0
    0
      doc/source/contributor/dashboards/index.rst
  5. 0
    0
      doc/source/contributor/development_environment.rst
  6. 0
    0
      doc/source/contributor/effective_neutron.rst
  7. 49
    10
      doc/source/contributor/index.rst
  8. 0
    0
      doc/source/contributor/internals/address_scopes.rst
  9. 0
    0
      doc/source/contributor/internals/agent_extensions.rst
  10. 0
    0
      doc/source/contributor/internals/api_extensions.rst
  11. 0
    0
      doc/source/contributor/internals/api_layer.rst
  12. 0
    0
      doc/source/contributor/internals/calling_ml2_plugin.rst
  13. 0
    0
      doc/source/contributor/internals/db_layer.rst
  14. 0
    0
      doc/source/contributor/internals/db_models.rst
  15. 0
    0
      doc/source/contributor/internals/dns_order.rst
  16. 0
    0
      doc/source/contributor/internals/external_dns_integration.rst
  17. 0
    0
      doc/source/contributor/internals/i18n.rst
  18. 0
    0
      doc/source/contributor/internals/images/live-mig-ovs-hybrid.png
  19. 0
    0
      doc/source/contributor/internals/images/live-mig-ovs-hybrid.txt
  20. 0
    0
      doc/source/contributor/internals/images/live-mig.png
  21. 0
    0
      doc/source/contributor/internals/images/live-mig.txt
  22. 0
    0
      doc/source/contributor/internals/images/under-the-hood-scenario-1-ovs-compute.png
  23. 0
    0
      doc/source/contributor/internals/images/under-the-hood-scenario-1-ovs-netns.png
  24. 0
    0
      doc/source/contributor/internals/images/under-the-hood-scenario-1-ovs-network.png
  25. 0
    0
      doc/source/contributor/internals/index.rst
  26. 0
    0
      doc/source/contributor/internals/l2_agent_extensions.rst
  27. 0
    0
      doc/source/contributor/internals/l2_agents.rst
  28. 0
    0
      doc/source/contributor/internals/l3_agent_extensions.rst
  29. 0
    0
      doc/source/contributor/internals/layer3.rst
  30. 0
    0
      doc/source/contributor/internals/linuxbridge_agent.rst
  31. 0
    0
      doc/source/contributor/internals/live_migration.rst
  32. 0
    0
      doc/source/contributor/internals/ml2_ext_manager.rst
  33. 0
    0
      doc/source/contributor/internals/network_ip_availability.rst
  34. 0
    0
      doc/source/contributor/internals/objects_usage.rst
  35. 0
    0
      doc/source/contributor/internals/openvswitch_agent.rst
  36. 0
    0
      doc/source/contributor/internals/openvswitch_firewall.rst
  37. 0
    0
      doc/source/contributor/internals/ovs_vhostuser.rst
  38. 0
    0
      doc/source/contributor/internals/plugin-api.rst
  39. 0
    0
      doc/source/contributor/internals/policy.rst
  40. 0
    0
      doc/source/contributor/internals/provisioning_blocks.rst
  41. 0
    0
      doc/source/contributor/internals/quality_of_service.rst
  42. 0
    0
      doc/source/contributor/internals/quota.rst
  43. 0
    0
      doc/source/contributor/internals/retries.rst
  44. 0
    0
      doc/source/contributor/internals/rpc_api.rst
  45. 0
    0
      doc/source/contributor/internals/rpc_callbacks.rst
  46. 0
    0
      doc/source/contributor/internals/security_group_api.rst
  47. 0
    0
      doc/source/contributor/internals/service_extensions.rst
  48. 0
    0
      doc/source/contributor/internals/services_and_agents.rst
  49. 0
    0
      doc/source/contributor/internals/sriov_nic_agent.rst
  50. 0
    0
      doc/source/contributor/internals/tag.rst
  51. 0
    0
      doc/source/contributor/internals/upgrade.rst
  52. 0
    0
      doc/source/contributor/modules.rst
  53. 0
    0
      doc/source/contributor/neutron_api.rst
  54. 0
    0
      doc/source/contributor/policies/blueprints.rst
  55. 0
    0
      doc/source/contributor/policies/bugs.rst
  56. 0
    0
      doc/source/contributor/policies/code-reviews.rst
  57. 0
    0
      doc/source/contributor/policies/contributor-onboarding.rst
  58. 0
    0
      doc/source/contributor/policies/gate-failure-triage.rst
  59. 0
    0
      doc/source/contributor/policies/gerrit-recheck.rst
  60. 0
    0
      doc/source/contributor/policies/index.rst
  61. 0
    0
      doc/source/contributor/policies/neutron-teams.rst
  62. 0
    0
      doc/source/contributor/policies/release-checklist.rst
  63. 0
    0
      doc/source/contributor/policies/thirdparty-ci.rst
  64. 0
    0
      doc/source/contributor/stadium/governance.rst
  65. 0
    0
      doc/source/contributor/stadium/guidelines.rst
  66. 0
    0
      doc/source/contributor/stadium/index.rst
  67. 0
    0
      doc/source/contributor/testing/coverage.rst
  68. 0
    0
      doc/source/contributor/testing/db_transient_failure_injection.rst
  69. 0
    0
      doc/source/contributor/testing/fullstack.rst
  70. 0
    0
      doc/source/contributor/testing/images/fullstack_multinode_simulation.png
  71. 2
    2
      doc/source/contributor/testing/index.rst
  72. 0
    0
      doc/source/contributor/testing/template_model_sync_test.rst
  73. 1
    1
      doc/source/contributor/testing/testing.rst
  74. 5
    34
      doc/source/index.rst

doc/source/devref/alembic_migrations.rst → doc/source/contributor/alembic_migrations.rst View File


doc/source/devref/client_command_extensions.rst → doc/source/contributor/client_command_extensions.rst View File


doc/source/devref/contribute.rst → doc/source/contributor/contribute.rst View File


doc/source/dashboards/index.rst → doc/source/contributor/dashboards/index.rst View File


doc/source/devref/development.environment.rst → doc/source/contributor/development_environment.rst View File


doc/source/devref/effective_neutron.rst → doc/source/contributor/effective_neutron.rst View File


doc/source/devref/index.rst → doc/source/contributor/index.rst View File

@@ -23,9 +23,28 @@
23 23
       '''''''  Heading 4
24 24
       (Avoid deeper levels because they do not render well.)
25 25
 
26
+=================
27
+Contributor Guide
28
+=================
29
+
30
+Neutron Policies
31
+----------------
32
+
33
+.. toctree::
34
+   :maxdepth: 2
35
+
36
+   policies/index
37
+
38
+Neutron Stadium
39
+---------------
40
+
41
+.. toctree::
42
+   :maxdepth: 2
43
+
44
+   stadium/index
26 45
 
27 46
 Developer Guide
28
-===============
47
+---------------
29 48
 
30 49
 In the Developer Guide, you will find information on Neutron's lower level
31 50
 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,
34 53
 the developer guide includes information about Neutron testing infrastructure.
35 54
 
36 55
 .. toctree::
37
-    :maxdepth: 2
38
-
39
-    effective_neutron
40
-    development.environment
41
-    contribute
42
-    neutron_api
43
-    client_command_extensions
44
-    alembic_migrations
45
-    modules
56
+   :maxdepth: 2
57
+
58
+   effective_neutron
59
+   development_environment
60
+   contribute
61
+   neutron_api
62
+   client_command_extensions
63
+   alembic_migrations
64
+   testing/index
65
+
66
+Neutron Internals
67
+-----------------
68
+
69
+.. toctree::
70
+   :maxdepth: 2
71
+
72
+   internals/index
73
+   modules
74
+
75
+Dashboards
76
+----------
77
+
78
+There is a collection of dashboards to help developers and reviewers
79
+located here.
80
+
81
+.. toctree::
82
+   :maxdepth: 2
83
+
84
+   dashboards/index

doc/source/devref/address_scopes.rst → doc/source/contributor/internals/address_scopes.rst View File


doc/source/devref/agent_extensions.rst → doc/source/contributor/internals/agent_extensions.rst View File


doc/source/devref/api_extensions.rst → doc/source/contributor/internals/api_extensions.rst View File


doc/source/devref/api_layer.rst → doc/source/contributor/internals/api_layer.rst View File


doc/source/devref/calling_ml2_plugin.rst → doc/source/contributor/internals/calling_ml2_plugin.rst View File


doc/source/devref/db_layer.rst → doc/source/contributor/internals/db_layer.rst View File


doc/source/devref/db_models.rst → doc/source/contributor/internals/db_models.rst View File


doc/source/devref/dns_order.rst → doc/source/contributor/internals/dns_order.rst View File


doc/source/devref/external_dns_integration.rst → doc/source/contributor/internals/external_dns_integration.rst View File


doc/source/devref/i18n.rst → doc/source/contributor/internals/i18n.rst View File


doc/source/devref/images/live-mig-ovs-hybrid.png → doc/source/contributor/internals/images/live-mig-ovs-hybrid.png View File


doc/source/devref/images/live-mig-ovs-hybrid.txt → doc/source/contributor/internals/images/live-mig-ovs-hybrid.txt View File


doc/source/devref/images/live-mig.png → doc/source/contributor/internals/images/live-mig.png View File


doc/source/devref/images/live-mig.txt → doc/source/contributor/internals/images/live-mig.txt View File


doc/source/devref/images/under-the-hood-scenario-1-ovs-compute.png → doc/source/contributor/internals/images/under-the-hood-scenario-1-ovs-compute.png View File


doc/source/devref/images/under-the-hood-scenario-1-ovs-netns.png → doc/source/contributor/internals/images/under-the-hood-scenario-1-ovs-netns.png View File


doc/source/devref/images/under-the-hood-scenario-1-ovs-network.png → doc/source/contributor/internals/images/under-the-hood-scenario-1-ovs-network.png View File


doc/source/devref/neutron_internals.rst → doc/source/contributor/internals/index.rst View File


doc/source/devref/l2_agent_extensions.rst → doc/source/contributor/internals/l2_agent_extensions.rst View File


doc/source/devref/l2_agents.rst → doc/source/contributor/internals/l2_agents.rst View File


doc/source/devref/l3_agent_extensions.rst → doc/source/contributor/internals/l3_agent_extensions.rst View File


doc/source/devref/layer3.rst → doc/source/contributor/internals/layer3.rst View File


doc/source/devref/linuxbridge_agent.rst → doc/source/contributor/internals/linuxbridge_agent.rst View File


doc/source/devref/live_migration.rst → doc/source/contributor/internals/live_migration.rst View File


doc/source/devref/ml2_ext_manager.rst → doc/source/contributor/internals/ml2_ext_manager.rst View File


doc/source/devref/network_ip_availability.rst → doc/source/contributor/internals/network_ip_availability.rst View File


doc/source/devref/objects_usage.rst → doc/source/contributor/internals/objects_usage.rst View File


doc/source/devref/openvswitch_agent.rst → doc/source/contributor/internals/openvswitch_agent.rst View File


doc/source/devref/openvswitch_firewall.rst → doc/source/contributor/internals/openvswitch_firewall.rst View File


doc/source/devref/ovs_vhostuser.rst → doc/source/contributor/internals/ovs_vhostuser.rst View File


doc/source/devref/plugin-api.rst → doc/source/contributor/internals/plugin-api.rst View File


doc/source/devref/policy.rst → doc/source/contributor/internals/policy.rst View File


doc/source/devref/provisioning_blocks.rst → doc/source/contributor/internals/provisioning_blocks.rst View File


doc/source/devref/quality_of_service.rst → doc/source/contributor/internals/quality_of_service.rst View File


doc/source/devref/quota.rst → doc/source/contributor/internals/quota.rst View File


doc/source/devref/retries.rst → doc/source/contributor/internals/retries.rst View File


doc/source/devref/rpc_api.rst → doc/source/contributor/internals/rpc_api.rst View File


doc/source/devref/rpc_callbacks.rst → doc/source/contributor/internals/rpc_callbacks.rst View File


doc/source/devref/security_group_api.rst → doc/source/contributor/internals/security_group_api.rst View File


doc/source/devref/service_extensions.rst → doc/source/contributor/internals/service_extensions.rst View File


doc/source/devref/services_and_agents.rst → doc/source/contributor/internals/services_and_agents.rst View File


doc/source/devref/sriov_nic_agent.rst → doc/source/contributor/internals/sriov_nic_agent.rst View File


doc/source/devref/tag.rst → doc/source/contributor/internals/tag.rst View File


doc/source/devref/upgrade.rst → doc/source/contributor/internals/upgrade.rst View File


doc/source/devref/modules.rst → doc/source/contributor/modules.rst View File


doc/source/devref/neutron_api.rst → doc/source/contributor/neutron_api.rst View File


doc/source/policies/blueprints.rst → doc/source/contributor/policies/blueprints.rst View File


doc/source/policies/bugs.rst → doc/source/contributor/policies/bugs.rst View File


doc/source/policies/code-reviews.rst → doc/source/contributor/policies/code-reviews.rst View File


doc/source/policies/contributor-onboarding.rst → doc/source/contributor/policies/contributor-onboarding.rst View File


doc/source/policies/gate-failure-triage.rst → doc/source/contributor/policies/gate-failure-triage.rst View File


doc/source/policies/gerrit-recheck.rst → doc/source/contributor/policies/gerrit-recheck.rst View File


doc/source/policies/index.rst → doc/source/contributor/policies/index.rst View File


doc/source/policies/neutron-teams.rst → doc/source/contributor/policies/neutron-teams.rst View File


doc/source/policies/release-checklist.rst → doc/source/contributor/policies/release-checklist.rst View File


doc/source/policies/thirdparty-ci.rst → doc/source/contributor/policies/thirdparty-ci.rst View File


doc/source/stadium/governance.rst → doc/source/contributor/stadium/governance.rst View File


doc/source/stadium/guidelines.rst → doc/source/contributor/stadium/guidelines.rst View File


doc/source/stadium/index.rst → doc/source/contributor/stadium/index.rst View File


doc/source/devref/testing_coverage.rst → doc/source/contributor/testing/coverage.rst View File


doc/source/devref/db_transient_failure_injection.rst → doc/source/contributor/testing/db_transient_failure_injection.rst View File


doc/source/devref/fullstack_testing.rst → doc/source/contributor/testing/fullstack.rst View File


doc/source/devref/images/fullstack_multinode_simulation.png → doc/source/contributor/testing/images/fullstack_multinode_simulation.png View File


doc/source/devref/testing_index.rst → doc/source/contributor/testing/index.rst View File

@@ -31,7 +31,7 @@ Testing
31 31
    :maxdepth: 2
32 32
 
33 33
    testing
34
-   fullstack_testing
35
-   testing_coverage
34
+   fullstack
35
+   coverage
36 36
    template_model_sync_test
37 37
    db_transient_failure_injection

doc/source/devref/template_model_sync_test.rst → doc/source/contributor/testing/template_model_sync_test.rst View File


doc/source/devref/testing.rst → doc/source/contributor/testing/testing.rst View File

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

+ 5
- 34
doc/source/index.rst View File

@@ -14,8 +14,8 @@
14 14
       License for the specific language governing permissions and limitations
15 15
       under the License.
16 16
 
17
-Welcome to Neutron's developer documentation!
18
-=============================================
17
+Welcome to Neutron's documentation!
18
+===================================
19 19
 
20 20
 Neutron is an OpenStack project to provide "network connectivity as a service"
21 21
 between interface devices (e.g., vNICs) managed by other OpenStack services
@@ -47,22 +47,6 @@ Networking Guide
47 47
 
48 48
    admin/index
49 49
 
50
-Neutron Policies
51
-----------------
52
-
53
-.. toctree::
54
-   :maxdepth: 2
55
-
56
-   policies/index
57
-
58
-Neutron Stadium
59
-----------------
60
-
61
-.. toctree::
62
-   :maxdepth: 2
63
-
64
-   stadium/index
65
-
66 50
 Neutron Feature Classification
67 51
 ------------------------------
68 52
 
@@ -71,26 +55,13 @@ Neutron Feature Classification
71 55
 
72 56
    feature_classification/index
73 57
 
74
-Developer Docs
75
---------------
76
-
77
-.. toctree::
78
-   :maxdepth: 2
79
-
80
-   devref/index
81
-   devref/testing_index
82
-   devref/neutron_internals
83
-
84
-Dashboards
85
-----------
86
-
87
-There is a collection of dashboards to help developers and reviewers
88
-located here.
58
+Contributor Guide
59
+-----------------
89 60
 
90 61
 .. toctree::
91 62
    :maxdepth: 2
92 63
 
93
-   dashboards/index
64
+   contributor/index
94 65
 
95 66
 API Extensions
96 67
 --------------

Loading…
Cancel
Save