Update documentation structure.
[kvmfornfv.git] / docs / index.rst
index 8198d85..b597d04 100644 (file)
@@ -1,6 +1,8 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
+.. _kvmfornfv-documentation:
+
 ******************
 Danube 1.0 Release
 ******************
@@ -14,68 +16,68 @@ Overview of Documentation
    :numbered:
    :maxdepth: 4
 
-   ./overview/kvmfornfv_overview.rst
+   ./development/overview/kvmfornfv_overview.rst
 
-********************************
-KVMFORNFV Installation Procedure
-********************************
+******************************
+KVM4NFV Installation Procedure
+******************************
 
 .. toctree::
-   :caption: Installation Procedure
+   :caption: Installation
    :numbered:
    :maxdepth: 4
 
-   ./installationprocedure/abstract.rst
-   ./installationprocedure/kvm4nfv-cicd.installation.instruction.rst
-   ./installationprocedure/kvm4nfv-cicd.release.notes.rst
+   ./release/installation/abstract.rst
+   ./release/installation/kvm4nfv-cicd.installation.instruction.rst
+   ./release/installation/kvm4nfv-cicd.release.notes.rst
 
-**********************
-KVMFORNFV Design Guide
-**********************
+********************
+KVM4NFV Design Guide
+********************
 
 .. toctree::
    :caption: Design Overview and Description
    :numbered:
    :maxdepth: 4
 
-   ./design/kvmfornfv_design.rst
+   ./development/design/kvmfornfv_design.rst
 
-****************************
-KVMFORNFV Requirements Guide
-****************************
+**************************
+KVM4NFV Requirements Guide
+**************************
 
 .. toctree::
    :caption: Requirements
    :numbered:
    :maxdepth: 4
 
-   ./requirements/kvmfornfv_requirements.rst
+   ./development/requirements/kvmfornfv_requirements.rst
 
-*****************************
-KVMFORNFV Configuration Guide
-*****************************
+***************************
+KVM4NFV Configuration Guide
+***************************
 
 .. toctree::
    :caption: Configuration Guide
    :numbered:
    :maxdepth: 4
 
-   ./configurationguide/abstract.rst
-   ./configurationguide/configuration.options.render.rst
-   ./configurationguide/low-latency.feature.configuration.description.rst
-   ./configurationguide/scenariomatrix.rst
+   ./release/configguide/abstract.rst
+   ./release/configguide/configuration.options.render.rst
+   ./release/configguide/scenariomatrix.rst
+   ./release/configguide/low-latency.feature.configuration.description.rst
 
-********************************************
-KVMFORNFV Scenarios Overview and Description
-********************************************
+******************************************
+KVM4NFV Scenarios Overview and Description
+******************************************
 
 .. toctree::
    :caption: Scenario Overview and Description
    :numbered:
    :maxdepth: 4
 
-   ./scenarios/abstract.rst
-   ./scenarios/kvmfornfv.scenarios.description.rst
+   ./release/scenarios/abstract.rst
+   ./release/scenarios/kvmfornfv.scenarios.description.rst
 
 *******************************************************
 os-nosdn-kvm_nfv_ovs_dpdk-noha Overview and Description
@@ -86,7 +88,7 @@ os-nosdn-kvm_nfv_ovs_dpdk-noha Overview and Description
    :numbered:
    :maxdepth: 3
 
-   ./scenarios/os-nosdn-kvm_nfv_ovs_dpdk-noha/os-nosdn-kvm_nfv_ovs_dpdk-noha.description.rst
+   ./release/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-noha/os-nosdn-kvm_nfv_ovs_dpdk-noha.description.rst
 
 *****************************************************
 os-nosdn-kvm_nfv_ovs_dpdk-ha Overview and Description
@@ -97,7 +99,7 @@ os-nosdn-kvm_nfv_ovs_dpdk-ha Overview and Description
    :numbered:
    :maxdepth: 3
 
-   ./scenarios/os-nosdn-kvm_nfv_ovs_dpdk-ha/os-nosdn-kvm_nfv_ovs_dpdk-ha.description.rst
+   ./release/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-ha/os-nosdn-kvm_nfv_ovs_dpdk-ha.description.rst
 
 ***********************************************************
 os-nosdn-kvm_nfv_ovs_dpdk_bar-noha Overview and Description
@@ -108,7 +110,7 @@ os-nosdn-kvm_nfv_ovs_dpdk_bar-noha Overview and Description
    :numbered:
    :maxdepth: 3
 
-   ./scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha.description.rst
+   ./release/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha.description.rst
 
 *********************************************************
 os-nosdn-kvm_nfv_ovs_dpdk_bar-ha Overview and Description
@@ -119,48 +121,37 @@ os-nosdn-kvm_nfv_ovs_dpdk_bar-ha Overview and Description
    :numbered:
    :maxdepth: 3
 
-   ./scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha.description.rst
+   ./release/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha.description.rst
 
-********************
-KVMFORNFV User Guide
-********************
+******************
+KVM4NFV User Guide
+******************
 
 .. toctree::
    :caption: User Guide
    :numbered:
    :maxdepth: 3
 
-   ./userguide/abstract.rst
-   ./userguide/introduction.rst
-   ./userguide/common.platform.render.rst
-   ./userguide/feature.userguide.render.rst
-   ./userguide/Ftrace.debugging.tool.userguide.rst
-   ./userguide/kvmfornfv.cyclictest-dashboard.userguide.rst
-   ./userguide/low_latency.userguide.rst
-   ./userguide/live_migration.userguide.rst
-   ./userguide/openstack.rst
-   ./userguide/packet_forwarding.userguide.rst
-   ./userguide/pcm_utility.userguide.rst
-   ./userguide/tuning.userguide.rst
-
-**********************
-KVMFORNFV Releasenotes
-**********************
-
-.. toctree::
-   :caption: Releasenotes
-   :numbered:
-   :maxdepth: 3
-
-   ./releasenotes/release-notes.rst
+   ./release/userguide/abstract.rst
+   ./release/userguide/introduction.rst
+   ./release/userguide/common.platform.render.rst
+   ./release/userguide/feature.userguide.render.rst
+   ./release/userguide/Ftrace.debugging.tool.userguide.rst
+   ./release/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst
+   ./release/userguide/low_latency.userguide.rst
+   ./release/userguide/live_migration.userguide.rst
+   ./release/userguide/openstack.rst
+   ./release/userguide/packet_forwarding.userguide.rst
+   ./release/userguide/pcm_utility.userguide.rst
+   ./release/userguide/tuning.userguide.rst
 
-******************
-KVMFORNFV Glossary
-******************
+********************
+KVM4NFV Releasenotes
+********************
 
 .. toctree::
-   :caption: Glossary
+   :caption: Releasenotes
    :numbered:
    :maxdepth: 3
 
-   ./glossary/kvmfornfv_glossary.rst
+   ./release/releasenotes/release-notes.rst