X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;fp=docs%2Findex.rst;h=8198d8597e42d91b400373343b705667b090fb7e;hb=9d3e1250c6c70a017262959bae68235ef8100684;hp=0000000000000000000000000000000000000000;hpb=52f993b8e89487ec9ee15a7fb4979e0f09a45b27;p=kvmfornfv.git diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..8198d8597 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,166 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +****************** +Danube 1.0 Release +****************** + +************************* +Overview of Documentation +************************* + +.. toctree:: + :caption: Overview + :numbered: + :maxdepth: 4 + + ./overview/kvmfornfv_overview.rst + +******************************** +KVMFORNFV Installation Procedure +******************************** + +.. toctree:: + :caption: Installation Procedure + :numbered: + :maxdepth: 4 + + ./installationprocedure/abstract.rst + ./installationprocedure/kvm4nfv-cicd.installation.instruction.rst + ./installationprocedure/kvm4nfv-cicd.release.notes.rst + +********************** +KVMFORNFV Design Guide +********************** + +.. toctree:: + :caption: Design Overview and Description + :numbered: + :maxdepth: 4 + + ./design/kvmfornfv_design.rst + +**************************** +KVMFORNFV Requirements Guide +**************************** + +.. toctree:: + :caption: Requirements + :numbered: + :maxdepth: 4 + + ./requirements/kvmfornfv_requirements.rst + +***************************** +KVMFORNFV 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 + +******************************************** +KVMFORNFV Scenarios Overview and Description +******************************************** + +.. toctree:: + :caption: Scenario Overview and Description + :numbered: + :maxdepth: 4 + + ./scenarios/abstract.rst + ./scenarios/kvmfornfv.scenarios.description.rst + +******************************************************* +os-nosdn-kvm_nfv_ovs_dpdk-noha Overview and Description +******************************************************* + +.. toctree:: + :caption: os-nosdn-kvm_nfv_ovs_dpdk-noha + :numbered: + :maxdepth: 3 + + ./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 +***************************************************** + +.. toctree:: + :caption: os-nosdn-kvm_nfv_ovs_dpdk-ha + :numbered: + :maxdepth: 3 + + ./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 +*********************************************************** + +.. toctree:: + :caption: os-nosdn-kvm_nfv_ovs_dpdk_bar-noha + :numbered: + :maxdepth: 3 + + ./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 +********************************************************* + +.. toctree:: + :caption: os-nosdn-kvm_nfv_ovs_dpdk_bar-ha + :numbered: + :maxdepth: 3 + + ./scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha.description.rst + +******************** +KVMFORNFV 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 + +****************** +KVMFORNFV Glossary +****************** + +.. toctree:: + :caption: Glossary + :numbered: + :maxdepth: 3 + + ./glossary/kvmfornfv_glossary.rst