Merge "Revert "Moved doc files to testing document structure"

32 files changed, 76 insertions, 65 deletions

diff --git a/docs/testing/developer/design/LICENSE b/docs/configguide/LICENSE
index 7bc572ce..7bc572ce 100644
--- a/docs/testing/developer/design/LICENSE
+++ b/docs/configguide/LICENSE
diff --git a/docs/testing/user/configguide/TCLServerProperties.png b/docs/configguide/TCLServerProperties.png
index 682de7c5..682de7c5 100644
--- a/docs/testing/user/configguide/TCLServerProperties.png
+++ b/docs/configguide/TCLServerProperties.png
diff --git a/docs/testing/user/configguide/installation.rst b/docs/configguide/installation.rst
index 1965a8f5..1965a8f5 100644
--- a/docs/testing/user/configguide/installation.rst
+++ b/docs/configguide/installation.rst
diff --git a/docs/testing/user/configguide/trafficgen.rst b/docs/configguide/trafficgen.rst
index 4e42b2be..4e42b2be 100644
--- a/docs/testing/user/configguide/trafficgen.rst
+++ b/docs/configguide/trafficgen.rst
diff --git a/docs/testing/user/configguide/upgrade.rst b/docs/configguide/upgrade.rst
index cf92572c..cf92572c 100644
--- a/docs/testing/user/configguide/upgrade.rst
+++ b/docs/configguide/upgrade.rst
diff --git a/docs/testing/developer/requirements/LICENSE b/docs/design/LICENSE
index 7bc572ce..7bc572ce 100644
--- a/docs/testing/developer/requirements/LICENSE
+++ b/docs/design/LICENSE
diff --git a/docs/testing/developer/design/factory_and_loader.png b/docs/design/factory_and_loader.png
index 290c0af6..290c0af6 100644
--- a/docs/testing/developer/design/factory_and_loader.png
+++ b/docs/design/factory_and_loader.png
diff --git a/docs/testing/developer/design/traffic_controller.png b/docs/design/traffic_controller.png
index 598296ec..598296ec 100644
--- a/docs/testing/developer/design/traffic_controller.png
+++ b/docs/design/traffic_controller.png
diff --git a/docs/testing/developer/design/trafficgen_integration_guide.rst b/docs/design/trafficgen_integration_guide.rst
index 382cedcb..382cedcb 100644
--- a/docs/testing/developer/design/trafficgen_integration_guide.rst
+++ b/docs/design/trafficgen_integration_guide.rst
diff --git a/docs/testing/developer/design/vsperf.png b/docs/design/vsperf.png
index 4af2ac62..4af2ac62 100644
--- a/docs/testing/developer/design/vsperf.png
+++ b/docs/design/vsperf.png
diff --git a/docs/testing/developer/design/vswitchperf_design.rst b/docs/design/vswitchperf_design.rst
index da7ec6fd..da7ec6fd 100644
--- a/docs/testing/developer/design/vswitchperf_design.rst
+++ b/docs/design/vswitchperf_design.rst
diff --git a/docs/index.rst b/docs/index.rst
index 11aaf655..889d4ab6 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -7,22 +7,20 @@
 ======
 VSPERF
 ======
-
 VSPERF is an OPNFV testing project.
 
-VSPERF provides a configurable and automated test-framework with test cases based on
-industry standard network benchmarks applicable to NFVI. This includes the network
-tolpology with physical and virtual network interfaces as well as the switching
-technology. The VSPERF architecture was designed to be switch and traffic generator
-agnostic and provides control of NFVI software components, switch configurations and
-test-case customization.
+VSPERF provides an automated test-framework and comprehensive test suite based on
+industry standards for measuring data-plane performance of Telco NFV switching
+technologies as well as physical and virtual network interfaces (NFVI). The VSPERF
+architecture is switch and traffic generator agnostic and provides full control of
+software component versions and configurations as well as test-case customization.
 
 The Danube release of VSPERF includes improvements in documentation and capabilities.
-This includes additional test-cases such as RFC 5481 (latency tests) and RFC-2889
-(address-learning-rate test). Hardware traffic generator support is now provided for
+This includes additional test-cases such as RFC 5481 Latency test and RFC-2889
+address-learning-rate test. Hardware traffic generator support is now provided for
 Spirent and Xena in addition to Ixia. The Moongen software traffic generator is also
-now supported. VSPERF can be used in a variety of modes for configuration and
-setup of the network and/or for control of the traffic-generator and test execution.
+now fully supported. VSPERF can be used in a variety of modes for configuration and
+setup of the network and/or for control of the test-generator and test execution.
 
 * Wiki: https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases
 * Repository: https://git.opnfv.org/vswitchperf
@@ -30,6 +28,19 @@ setup of the network and/or for control of the traffic-generator and test execut
 * Continuous Integration status: https://build.opnfv.org/ci/view/vswitchperf/
 
 ******************************
+VSPERF Installation Guide
+******************************
+
+.. toctree::
+   :caption: VSPERF Installation Guide
+   :maxdepth: 5
+   :numbered: 5
+
+   ./configguide/installation.rst
+   ./configguide/upgrade.rst
+   ./configguide/trafficgen.rst
+
+******************************
 VSPERF User Guide
 ******************************
 
@@ -38,44 +49,44 @@ VSPERF User Guide
    :maxdepth: 5
    :numbered: 5
 
-   ./user/configguide/installation.rst
-   ./user/configguide/upgrade.rst
-   ./user/configguide/trafficgen.rst
-
-   ./user/userguide/testusage.rst
-   ./user/userguide/teststeps.rst
-   ./user/userguide/integration.rst
+   ./userguide/testusage.rst
+   ./userguide/teststeps.rst
+   ./userguide/integration.rst
    Yardstick integration <./userguide/yardstick.rst>
 
-
-****************************
-VSPERF Developer
-****************************
+**************
+VSPERF Design
+**************
 
 .. toctree::
-   :caption: VSPERF Developer Guide
+   :caption: VSPERF Design
    :maxdepth: 5
    :numbered: 5
 
-   ./developer/design/trafficgen_integration_guide.rst
-   ./developer/design/vswitchperf_design.rst
+   ./design/vswitchperf_design.rst
+   ./design/trafficgen_integration_guide.rst
 
-   ./developer/requirements/vswitchperf_ltd.rst
-   ./developer/requirements/vswitchperf_ltp.rst
-   IETF Internet Draft: Benchmarking Virtual Switches in OPNFV <./requirements/ietf_draft/>
+*******************
+VSPERF Requirements
+*******************
+
+.. toctree::
+   :caption: VSPERF Requirements
+   :maxdepth: 5
+   :numbered: 5
 
+   ./requirements/vswitchperf_ltp.rst
+   ./requirements/vswitchperf_ltd.rst
 
-******************************
+**************
 VSPERF Results
-******************************
+**************
 
 .. toctree::
-   :caption: VSPERF Scenarios and Test Cases
    :maxdepth: 3
-   :numbered: 3
 
-   ./developer/results/scenario.rst
-   ./developer/results/results.rst
+   ./results/scenario.rst
+   ./results/results.rst
 
 Indices
 =======
diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst
index 8b38d53e..eaa7bb71 100644
--- a/docs/release/release-notes/index.rst
+++ b/docs/release/release-notes/index.rst
@@ -1,21 +1,12 @@
-.. _vswitchperf-releasenotes:
-
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) OPNFV, Intel Corporation and others.
 
-====================
-VSPERF Release Notes
-====================
+==================================================
+OPNFV VSPERF Release Notes
+==================================================
 
 .. toctree::
-   :numbered:
-   :maxdepth: 2
-
-   release-notes.rst
-
-Revision: _sha1_
-
-:Author: Trevor Cooper (trevor.cooper@intel.com)
+   :maxdepth: 1
 
-Build date: |today|
+   release-notes
diff --git a/docs/testing/user/configguide/LICENSE b/docs/requirements/LICENSE
index 7bc572ce..7bc572ce 100644
--- a/docs/testing/user/configguide/LICENSE
+++ b/docs/requirements/LICENSE
diff --git a/docs/testing/developer/requirements/ietf_draft/LICENSE b/docs/requirements/ietf_draft/LICENSE
index 7fc9ae14..7fc9ae14 100644
--- a/docs/testing/developer/requirements/ietf_draft/LICENSE
+++ b/docs/requirements/ietf_draft/LICENSE
diff --git a/docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml b/docs/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml
index 2259b23c..2259b23c 100644
--- a/docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml
+++ b/docs/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml
diff --git a/docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml b/docs/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml
index c8a3d99b..c8a3d99b 100644
--- a/docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml
+++ b/docs/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml
diff --git a/docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml b/docs/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml
index b5f7f833..b5f7f833 100644
--- a/docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml
+++ b/docs/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml
diff --git a/docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml b/docs/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml
index a9405a77..a9405a77 100644
--- a/docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml
+++ b/docs/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml
diff --git a/docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml b/docs/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml
index 9157763e..9157763e 100644
--- a/docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml
+++ b/docs/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml
diff --git a/docs/testing/developer/requirements/vm2vm_alternative_benchmark.png b/docs/requirements/vm2vm_alternative_benchmark.png
index d21334ba..d21334ba 100644
--- a/docs/testing/developer/requirements/vm2vm_alternative_benchmark.png
+++ b/docs/requirements/vm2vm_alternative_benchmark.png
diff --git a/docs/testing/developer/requirements/vm2vm_benchmark.png b/docs/requirements/vm2vm_benchmark.png
index 3a85e51f..3a85e51f 100644
--- a/docs/testing/developer/requirements/vm2vm_benchmark.png
+++ b/docs/requirements/vm2vm_benchmark.png
diff --git a/docs/testing/developer/requirements/vm2vm_hypervisor_benchmark.png b/docs/requirements/vm2vm_hypervisor_benchmark.png
index b5b76e8a..b5b76e8a 100644
--- a/docs/testing/developer/requirements/vm2vm_hypervisor_benchmark.png
+++ b/docs/requirements/vm2vm_hypervisor_benchmark.png
diff --git a/docs/testing/developer/requirements/vm2vm_virtual_interface_benchmark.png b/docs/requirements/vm2vm_virtual_interface_benchmark.png
index 55294af6..55294af6 100644
--- a/docs/testing/developer/requirements/vm2vm_virtual_interface_benchmark.png
+++ b/docs/requirements/vm2vm_virtual_interface_benchmark.png
diff --git a/docs/testing/developer/requirements/vswitchperf_ltd.rst b/docs/requirements/vswitchperf_ltd.rst
index e1372520..e1372520 100644
--- a/docs/testing/developer/requirements/vswitchperf_ltd.rst
+++ b/docs/requirements/vswitchperf_ltd.rst
diff --git a/docs/testing/developer/requirements/vswitchperf_ltp.rst b/docs/requirements/vswitchperf_ltp.rst
index 2b74d676..2b74d676 100644
--- a/docs/testing/developer/requirements/vswitchperf_ltp.rst
+++ b/docs/requirements/vswitchperf_ltp.rst
diff --git a/docs/testing/developer/results/results.rst b/docs/results/results.rst
index 42df9611..1fd6d443 100644
--- a/docs/testing/developer/results/results.rst
+++ b/docs/results/results.rst
@@ -2,10 +2,10 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) OPNFV, Intel Corporation, AT&T and others.
 
-OPNFV VSPERF CI Results
+OPNFV Brahmaputra Results
 =========================
-The VSPERF CI jobs are run daily through Jenkins. Result samples can be found at
-https://wiki.opnfv.org/display/vsperf/Vsperf+Results
+The vsperf CI jobs that were used to obtain the
+results can be found at https://wiki.opnfv.org/wiki/vsperf_results.
 
 The following table maps the results in the test dashboard to the appropriate
 test case in the VSPERF Framework and specifies the metric the vertical/Y axis
diff --git a/docs/testing/developer/results/scenario.rst b/docs/results/scenario.rst
index 2967fc60..49ff626a 100644
--- a/docs/testing/developer/results/scenario.rst
+++ b/docs/results/scenario.rst
@@ -2,23 +2,12 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) OPNFV, Intel Corporation, AT&T and others.
 
-OPNFV VSPERF Scenarios
+OPNFV Brahmaputra Scenarios
 ===========================
-
-Predefined network topologies:
-
-* :ref:`Phy2Phy <Phy2Phy>`: Physical port -> vSwitch -> Physical port.
-* :ref:`PVP <PVP>`: Physical port -> vSwitch -> VNF -> vSwitch -> Physical port.
-* :ref:`PVVP <PVVP>`: Physical port -> vSwitch -> VNF -> vSwitch -> VNF -> vSwitch ->
-  Physical port.
-
-Loopback applications in the Guest can be:
-* `DPDK testpmd <http://dpdk.org/doc/guides/testpmd_app_ug/index.html>`_.
-* Linux Bridge.
-* :ref:`l2fwd-module`
+Available Tests and aspects of scenarios:
 
 ===================== ===========================================================
-   Testcase                          Definition
+   Framework Test                          Definition
 ===================== ===========================================================
 phy2phy_tput          :ref:`PacketLossRatio <PacketLossRatio>` for :ref:`Phy2Phy <Phy2Phy>`
 back2back             :ref:`BackToBackFrames <BackToBackFrames>` for :ref:`Phy2Phy <Phy2Phy>`
@@ -34,3 +23,23 @@ pvvp_back2back        :ref:`BackToBackFrames <BackToBackFrames>` for :ref:`PVVP
 phy2phy_cpu_load      :ref:`CPU0PacketLoss <CPU0PacketLoss>` for :ref:`Phy2Phy <Phy2Phy>`
 phy2phy_mem_load      Same as :ref:`CPU0PacketLoss <CPU0PacketLoss>` but using a memory intensive app
 ===================== ===========================================================
+
+Supported deployment scenarios:
+
+* :ref:`Phy2Phy <Phy2Phy>`: Physical port -> vSwitch -> Physical port.
+* :ref:`PVP <PVP>`: Physical port -> vSwitch -> VNF -> vSwitch -> Physical port.
+* :ref:`PVVP <PVVP>`: Physical port -> vSwitch -> VNF -> vSwitch -> VNF -> vSwitch ->
+  Physical port.
+
+Loopback applications in the Guest can be:
+
+* `DPDK testpmd <http://dpdk.org/doc/guides/testpmd_app_ug/index.html>`_.
+* Linux Bridge.
+* :ref:`l2fwd-module`
+
+Supported traffic generators:
+
+* Ixia: IxOS and IxNet.
+* Spirent.
+* Dummy.
+
diff --git a/docs/testing/user/userguide/integration.rst b/docs/userguide/integration.rst
index 83b29da6..83b29da6 100644
--- a/docs/testing/user/userguide/integration.rst
+++ b/docs/userguide/integration.rst
diff --git a/docs/testing/user/userguide/teststeps.rst b/docs/userguide/teststeps.rst
index 870c3d80..870c3d80 100644
--- a/docs/testing/user/userguide/teststeps.rst
+++ b/docs/userguide/teststeps.rst
diff --git a/docs/testing/user/userguide/testusage.rst b/docs/userguide/testusage.rst
index c6037aaf..c6037aaf 100644
--- a/docs/testing/user/userguide/testusage.rst
+++ b/docs/userguide/testusage.rst
diff --git a/docs/testing/user/userguide/yardstick.rst b/docs/userguide/yardstick.rst
index b5e5c72d..b5e5c72d 100644
--- a/docs/testing/user/userguide/yardstick.rst
+++ b/docs/userguide/yardstick.rst