Merge "improve documentation structure"

diff --git a/docs/contributor-guide/coding-guidelines.rst b/docs/contributor-guides/coding-guidelines/index.rst
similarity index 100%
rename from docs/contributor-guide/coding-guidelines.rst
rename to docs/contributor-guides/coding-guidelines/index.rst

diff --git a/docs/contributor-guides/index.rst b/docs/contributor-guides/index.rst
new file mode 100644 (file)
index 0000000..8c383ef
--- /dev/null
+++ b/docs/contributor-guides/index.rst
@@ -0,0 +1,17 @@
+##################
+Contributor Guides
+##################
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   newcomers-guide
+
+* :doc:`Gerrit Guide <lfdocs:gerrit>`
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   coding-guidelines/index

diff --git a/docs/contributor-guide/newcomers-guide.rst b/docs/contributor-guides/newcomers-guide.rst
similarity index 99%
rename from docs/contributor-guide/newcomers-guide.rst
rename to docs/contributor-guides/newcomers-guide.rst
index 488827573fa2278ede0d3374ef24b6c94be6002b..5bd56858d6c33a149721ac75f3f5a660105520c9 100644 (file)
--- a/docs/contributor-guide/newcomers-guide.rst
+++ b/docs/contributor-guides/newcomers-guide.rst
@@ -1,3 +1,7 @@
+###############
+Newcomers Guide
+###############
+
 What is Gerrit ?
 ================
 

diff --git a/docs/developer-guide/developing-apps-on-the-opendaylight-controller.rst b/docs/developer-guides/developing-apps-on-the-opendaylight-controller.rst
similarity index 100%
rename from docs/developer-guide/developing-apps-on-the-opendaylight-controller.rst
rename to docs/developer-guides/developing-apps-on-the-opendaylight-controller.rst

diff --git a/docs/developer-guide/distribution-test-features.rst b/docs/developer-guides/distribution-test-features.rst
similarity index 100%
rename from docs/developer-guide/distribution-test-features.rst
rename to docs/developer-guides/distribution-test-features.rst

diff --git a/docs/developer-guide/distribution-version.rst b/docs/developer-guides/distribution-version.rst
similarity index 100%
rename from docs/developer-guide/distribution-version.rst
rename to docs/developer-guides/distribution-version.rst

diff --git a/docs/developer-guide/images/800p_OpenDaylight_Login.jpg b/docs/developer-guides/images/800p_OpenDaylight_Login.jpg
similarity index 100%
rename from docs/developer-guide/images/800p_OpenDaylight_Login.jpg
rename to docs/developer-guides/images/800p_OpenDaylight_Login.jpg

diff --git a/docs/developer-guide/images/ConfigurationService-example1.png b/docs/developer-guides/images/ConfigurationService-example1.png
similarity index 100%
rename from docs/developer-guide/images/ConfigurationService-example1.png
rename to docs/developer-guides/images/ConfigurationService-example1.png

diff --git a/docs/developer-guide/images/L3FwdSample.png b/docs/developer-guides/images/L3FwdSample.png
similarity index 100%
rename from docs/developer-guide/images/L3FwdSample.png
rename to docs/developer-guides/images/L3FwdSample.png

diff --git a/docs/developer-guide/images/MonitorResponse.png b/docs/developer-guides/images/MonitorResponse.png
similarity index 100%
rename from docs/developer-guide/images/MonitorResponse.png
rename to docs/developer-guides/images/MonitorResponse.png

diff --git a/docs/developer-guide/images/OVSDB_Eclipse.png b/docs/developer-guides/images/OVSDB_Eclipse.png
similarity index 100%
rename from docs/developer-guide/images/OVSDB_Eclipse.png
rename to docs/developer-guides/images/OVSDB_Eclipse.png

diff --git a/docs/developer-guide/images/SDNiWrapper.png b/docs/developer-guides/images/SDNiWrapper.png
similarity index 100%
rename from docs/developer-guide/images/SDNiWrapper.png
rename to docs/developer-guides/images/SDNiWrapper.png

diff --git a/docs/developer-guide/images/neutron/odl-neutron-service-developer-architecture.png b/docs/developer-guides/images/neutron/odl-neutron-service-developer-architecture.png
similarity index 100%
rename from docs/developer-guide/images/neutron/odl-neutron-service-developer-architecture.png
rename to docs/developer-guides/images/neutron/odl-neutron-service-developer-architecture.png

diff --git a/docs/developer-guide/images/nic/MPLS_VPN_Service_Diagram.png b/docs/developer-guides/images/nic/MPLS_VPN_Service_Diagram.png
similarity index 100%
rename from docs/developer-guide/images/nic/MPLS_VPN_Service_Diagram.png
rename to docs/developer-guides/images/nic/MPLS_VPN_Service_Diagram.png

diff --git a/docs/developer-guide/images/openflowjava/500px-UdpChannelPipeline.png b/docs/developer-guides/images/openflowjava/500px-UdpChannelPipeline.png
similarity index 100%
rename from docs/developer-guide/images/openflowjava/500px-UdpChannelPipeline.png
rename to docs/developer-guides/images/openflowjava/500px-UdpChannelPipeline.png

diff --git a/docs/developer-guide/images/openflowjava/800px-Extensibility.png b/docs/developer-guides/images/openflowjava/800px-Extensibility.png
similarity index 100%
rename from docs/developer-guide/images/openflowjava/800px-Extensibility.png
rename to docs/developer-guides/images/openflowjava/800px-Extensibility.png

diff --git a/docs/developer-guide/images/openflowjava/800px-Extensibility2.png b/docs/developer-guides/images/openflowjava/800px-Extensibility2.png
similarity index 100%
rename from docs/developer-guide/images/openflowjava/800px-Extensibility2.png
rename to docs/developer-guides/images/openflowjava/800px-Extensibility2.png

diff --git a/docs/developer-guide/images/openflowjava/Library_lifecycle.png b/docs/developer-guides/images/openflowjava/Library_lifecycle.png
similarity index 100%
rename from docs/developer-guide/images/openflowjava/Library_lifecycle.png
rename to docs/developer-guides/images/openflowjava/Library_lifecycle.png

diff --git a/docs/developer-guide/images/openflowplugin/odl-ofp-add-flow.png b/docs/developer-guides/images/openflowplugin/odl-ofp-add-flow.png
similarity index 100%
rename from docs/developer-guide/images/openflowplugin/odl-ofp-add-flow.png
rename to docs/developer-guides/images/openflowplugin/odl-ofp-add-flow.png

diff --git a/docs/developer-guide/images/openflowplugin/odl-ofp-feature-tree.png b/docs/developer-guides/images/openflowplugin/odl-ofp-feature-tree.png
similarity index 100%
rename from docs/developer-guide/images/openflowplugin/odl-ofp-feature-tree.png
rename to docs/developer-guides/images/openflowplugin/odl-ofp-feature-tree.png

diff --git a/docs/developer-guide/images/openflowplugin/odl-ofp-handshake.png b/docs/developer-guides/images/openflowplugin/odl-ofp-handshake.png
similarity index 100%
rename from docs/developer-guide/images/openflowplugin/odl-ofp-handshake.png
rename to docs/developer-guides/images/openflowplugin/odl-ofp-handshake.png

diff --git a/docs/developer-guide/images/openflowplugin/odl-ofp-ofplugin-debug-stats.png b/docs/developer-guides/images/openflowplugin/odl-ofp-ofplugin-debug-stats.png
similarity index 100%
rename from docs/developer-guide/images/openflowplugin/odl-ofp-ofplugin-debug-stats.png
rename to docs/developer-guides/images/openflowplugin/odl-ofp-ofplugin-debug-stats.png

diff --git a/docs/developer-guide/images/openflowplugin/odl-ofp-session-establishment.jpg b/docs/developer-guides/images/openflowplugin/odl-ofp-session-establishment.jpg
similarity index 100%
rename from docs/developer-guide/images/openflowplugin/odl-ofp-session-establishment.jpg
rename to docs/developer-guides/images/openflowplugin/odl-ofp-session-establishment.jpg

diff --git a/docs/developer-guide/images/openstack_integration.png b/docs/developer-guides/images/openstack_integration.png
similarity index 100%
rename from docs/developer-guide/images/openstack_integration.png
rename to docs/developer-guides/images/openstack_integration.png

diff --git a/docs/developer-guide/images/ovsdb-sb-active-connection.jpg b/docs/developer-guides/images/ovsdb-sb-active-connection.jpg
similarity index 100%
rename from docs/developer-guide/images/ovsdb-sb-active-connection.jpg
rename to docs/developer-guides/images/ovsdb-sb-active-connection.jpg

diff --git a/docs/developer-guide/images/ovsdb-sb-config-crud.jpg b/docs/developer-guides/images/ovsdb-sb-config-crud.jpg
similarity index 100%
rename from docs/developer-guide/images/ovsdb-sb-config-crud.jpg
rename to docs/developer-guides/images/ovsdb-sb-config-crud.jpg

diff --git a/docs/developer-guide/images/ovsdb-sb-oper-crud.jpg b/docs/developer-guides/images/ovsdb-sb-oper-crud.jpg
similarity index 100%
rename from docs/developer-guide/images/ovsdb-sb-oper-crud.jpg
rename to docs/developer-guides/images/ovsdb-sb-oper-crud.jpg

diff --git a/docs/developer-guide/images/ovsdb-sb-passive-connection.jpg b/docs/developer-guides/images/ovsdb-sb-passive-connection.jpg
similarity index 100%
rename from docs/developer-guide/images/ovsdb-sb-passive-connection.jpg
rename to docs/developer-guides/images/ovsdb-sb-passive-connection.jpg

diff --git a/docs/developer-guide/images/packetcable-developer-wireshark.png b/docs/developer-guides/images/packetcable-developer-wireshark.png
similarity index 100%
rename from docs/developer-guide/images/packetcable-developer-wireshark.png
rename to docs/developer-guides/images/packetcable-developer-wireshark.png

diff --git a/docs/developer-guide/images/sfc-pot-int-arch.png b/docs/developer-guides/images/sfc-pot-int-arch.png
similarity index 100%
rename from docs/developer-guide/images/sfc-pot-int-arch.png
rename to docs/developer-guides/images/sfc-pot-int-arch.png

diff --git a/docs/developer-guide/images/sfc-pot-time-seq.png b/docs/developer-guides/images/sfc-pot-time-seq.png
similarity index 100%
rename from docs/developer-guide/images/sfc-pot-time-seq.png
rename to docs/developer-guides/images/sfc-pot-time-seq.png

diff --git a/docs/developer-guide/images/sfc-sf-selection-arch.png b/docs/developer-guides/images/sfc-sf-selection-arch.png
similarity index 100%
rename from docs/developer-guide/images/sfc-sf-selection-arch.png
rename to docs/developer-guides/images/sfc-sf-selection-arch.png

diff --git a/docs/developer-guide/images/snbi/docker_snbi.png b/docs/developer-guides/images/snbi/docker_snbi.png
similarity index 100%
rename from docs/developer-guide/images/snbi/docker_snbi.png
rename to docs/developer-guides/images/snbi/docker_snbi.png

diff --git a/docs/developer-guide/images/snbi/first_fe_bs.png b/docs/developer-guides/images/snbi/first_fe_bs.png
similarity index 100%
rename from docs/developer-guide/images/snbi/first_fe_bs.png
rename to docs/developer-guides/images/snbi/first_fe_bs.png

diff --git a/docs/developer-guide/images/snbi/snbi_arch.png b/docs/developer-guides/images/snbi/snbi_arch.png
similarity index 100%
rename from docs/developer-guide/images/snbi/snbi_arch.png
rename to docs/developer-guides/images/snbi/snbi_arch.png

diff --git a/docs/developer-guide/images/topoprocessing/Inventory_Rendering_Use_case.png b/docs/developer-guides/images/topoprocessing/Inventory_Rendering_Use_case.png
similarity index 100%
rename from docs/developer-guide/images/topoprocessing/Inventory_Rendering_Use_case.png
rename to docs/developer-guides/images/topoprocessing/Inventory_Rendering_Use_case.png

diff --git a/docs/developer-guide/images/topoprocessing/Inventory_model_listener_diagram.png b/docs/developer-guides/images/topoprocessing/Inventory_model_listener_diagram.png
similarity index 100%
rename from docs/developer-guide/images/topoprocessing/Inventory_model_listener_diagram.png
rename to docs/developer-guides/images/topoprocessing/Inventory_model_listener_diagram.png

diff --git a/docs/developer-guide/images/topoprocessing/LinkComputation.png b/docs/developer-guides/images/topoprocessing/LinkComputation.png
similarity index 100%
rename from docs/developer-guide/images/topoprocessing/LinkComputation.png
rename to docs/developer-guides/images/topoprocessing/LinkComputation.png

diff --git a/docs/developer-guide/images/topoprocessing/LinkComputationFlowDiagram.png b/docs/developer-guides/images/topoprocessing/LinkComputationFlowDiagram.png
similarity index 100%
rename from docs/developer-guide/images/topoprocessing/LinkComputationFlowDiagram.png
rename to docs/developer-guides/images/topoprocessing/LinkComputationFlowDiagram.png

diff --git a/docs/developer-guide/images/topoprocessing/ModelAdapter.png b/docs/developer-guides/images/topoprocessing/ModelAdapter.png
similarity index 100%
rename from docs/developer-guide/images/topoprocessing/ModelAdapter.png
rename to docs/developer-guides/images/topoprocessing/ModelAdapter.png

diff --git a/docs/developer-guide/images/topoprocessing/Network_topology_model_flow_diagram.png b/docs/developer-guides/images/topoprocessing/Network_topology_model_flow_diagram.png
similarity index 100%
rename from docs/developer-guide/images/topoprocessing/Network_topology_model_flow_diagram.png
rename to docs/developer-guides/images/topoprocessing/Network_topology_model_flow_diagram.png

diff --git a/docs/developer-guide/images/topoprocessing/TopologyRequestHandler_classesRelationship.png b/docs/developer-guides/images/topoprocessing/TopologyRequestHandler_classesRelationship.png
similarity index 100%
rename from docs/developer-guide/images/topoprocessing/TopologyRequestHandler_classesRelationship.png
rename to docs/developer-guides/images/topoprocessing/TopologyRequestHandler_classesRelationship.png

diff --git a/docs/developer-guide/images/topoprocessing/wrapper.png b/docs/developer-guides/images/topoprocessing/wrapper.png
similarity index 100%
rename from docs/developer-guide/images/topoprocessing/wrapper.png
rename to docs/developer-guides/images/topoprocessing/wrapper.png

diff --git a/docs/developer-guide/images/yang-data-api.png b/docs/developer-guides/images/yang-data-api.png
similarity index 100%
rename from docs/developer-guide/images/yang-data-api.png
rename to docs/developer-guides/images/yang-data-api.png

diff --git a/docs/developer-guide/images/yang-model-api.png b/docs/developer-guides/images/yang-model-api.png
similarity index 100%
rename from docs/developer-guide/images/yang-model-api.png
rename to docs/developer-guides/images/yang-model-api.png

diff --git a/docs/developer-guide/index.rst b/docs/developer-guides/index.rst
similarity index 74%
rename from docs/developer-guide/index.rst
rename to docs/developer-guides/index.rst
index af8aead439e2559f50c02091ab217094e1ee116f..606f38299b8234f4f682415a80931ac972e64021 100644 (file)
--- a/docs/developer-guide/index.rst
+++ b/docs/developer-guides/index.rst
@@ -1,12 +1,10 @@
-.. _developer_guide:
+.. _developer_guides:
 
-Developer Guide
-===============
+Developer Guides
+================
 
-Overview
---------
-
-* :doc:`Gerrit Guide <lfdocs:gerrit>`
+Generic
+-------
 
 .. toctree::
    :maxdepth: 1
@@ -14,14 +12,9 @@ Overview
    developing-apps-on-the-opendaylight-controller
    integrating-animal-sniffer-plugin-with-projects
 
-Project-specific Developer Guides
+Core features Developer Guides
 ---------------------------------
 
-* :doc:`InfraUtils Documentation <infrautils:index>`
-* :doc:`JSON RPC Documentation <jsonrpc:index>`
-* :doc:`NetVirt Documentation <netvirt:index>`
-* :doc:`OVSDB Documentation <ovsdb:index>`
-
 .. toctree::
    :maxdepth: 1
 
@@ -31,3 +24,14 @@ Project-specific Developer Guides
    neutron-northbound
    odl-parent-developer-guide
    yang-tools
+
+
+Project-specific Developer Guides
+---------------------------------
+
+* :doc:`InfraUtils Documentation <infrautils:index>`
+* :doc:`JSON RPC Documentation <jsonrpc:index>`
+* :doc:`NetVirt Documentation <netvirt:index>`
+* :doc:`OVSDB Documentation <ovsdb:index>`
+* :doc:`TransportPCE Documentation <transportpce:index>`
+

diff --git a/docs/developer-guide/integrating-animal-sniffer-plugin-with-projects.rst b/docs/developer-guides/integrating-animal-sniffer-plugin-with-projects.rst
similarity index 100%
rename from docs/developer-guide/integrating-animal-sniffer-plugin-with-projects.rst
rename to docs/developer-guides/integrating-animal-sniffer-plugin-with-projects.rst

diff --git a/docs/developer-guide/neutron-northbound.rst b/docs/developer-guides/neutron-northbound.rst
similarity index 100%
rename from docs/developer-guide/neutron-northbound.rst
rename to docs/developer-guides/neutron-northbound.rst

diff --git a/docs/developer-guide/neutron-service-developer-guide.rst b/docs/developer-guides/neutron-service-developer-guide.rst
similarity index 100%
rename from docs/developer-guide/neutron-service-developer-guide.rst
rename to docs/developer-guides/neutron-service-developer-guide.rst

diff --git a/docs/developer-guide/odl-parent-developer-guide.rst b/docs/developer-guides/odl-parent-developer-guide.rst
similarity index 100%
rename from docs/developer-guide/odl-parent-developer-guide.rst
rename to docs/developer-guides/odl-parent-developer-guide.rst

diff --git a/docs/developer-guide/yang-tools.rst b/docs/developer-guides/yang-tools.rst
similarity index 100%
rename from docs/developer-guide/yang-tools.rst
rename to docs/developer-guides/yang-tools.rst

diff --git a/docs/index.rst b/docs/index.rst
index 1f93d2f8f5090346028bc41a925092744eb3557e..1eafc176ba3ecb73649baf1937bbb455e117a9fd 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -19,9 +19,19 @@ Getting Started with OpenDaylight
    downloads
    release-notes/index
    getting-started-guide/index
-   developer-guide/developing-apps-on-the-opendaylight-controller
-   contributor-guide/newcomers-guide
-   contributor-guide/coding-guidelines
+   developer-guides/index
+
+Contributing to OpenDaylight
+----------------------------
+
+* :doc:`Contributor Guides <contributor-guides/index>`
+* :ref:`Infrastructure Guide <odl-infra>`
+* :doc:`Integration Testing Guide <odl-integration-test:index>`
+* :doc:`Integration Distribution Guide <integration-distribution:index>`
+* :doc:`Integration Packaging Guide <odl-integration-packaging:index>`
+* :doc:`Release Process Guide <release-process/index>`
+* :doc:`Documentation Guide <documentation>`
+* :doc:`Javadocs <javadoc>`
 
 OpenDaylight Project Documentation
 ----------------------------------
@@ -51,19 +61,6 @@ Self-Managed Projects
 
 * :doc:`TransportPCE Documentation <transportpce:index>`
 
-OpenDaylight Contributor Guides
--------------------------------
-
-* :doc:`Newcomers Guide <contributor-guide/newcomers-guide>`
-* :doc:`Gerrit Guide <lfdocs:gerrit>`
-* :ref:`Infrastructure Guide <odl-infra>`
-* :doc:`Integration Testing Guide <odl-integration-test:index>`
-* :doc:`Integration Distribution Guide <integration-distribution:index>`
-* :doc:`Integration Packaging Guide <odl-integration-packaging:index>`
-* :doc:`Release Process Guide <release-process/index>`
-* :doc:`Documentation Guide <documentation>`
-* :doc:`Javadocs <javadoc>`
-
 
 .. Commenting the below out until we actually use it
 .. Indices and tables
@@ -82,4 +79,5 @@ OpenDaylight Contributor Guides
    release-process/index
    javadoc
    user-guide/index
-   developer-guide/index
+   developer-guides/index
+   contributor-guides/index