Moved devguide for consitency with docs dir structure for all testing projects

Updated RFC description based on IETF approval of Internet Draft

Change-Id: Ifd37da946866f350b8968bbbe8c5a3f5ce762cfa
Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>

diff --git a/docs/testing/developer/design/LICENSE b/docs/testing/developer/devguide/design/LICENSE
similarity index 100%
rename from docs/testing/developer/design/LICENSE
rename to docs/testing/developer/devguide/design/LICENSE

diff --git a/docs/testing/developer/design/factory_and_loader.png b/docs/testing/developer/devguide/design/factory_and_loader.png
similarity index 100%
rename from docs/testing/developer/design/factory_and_loader.png
rename to docs/testing/developer/devguide/design/factory_and_loader.png

diff --git a/docs/testing/developer/design/traffic_controller.png b/docs/testing/developer/devguide/design/traffic_controller.png
similarity index 100%
rename from docs/testing/developer/design/traffic_controller.png
rename to docs/testing/developer/devguide/design/traffic_controller.png

diff --git a/docs/testing/developer/design/trafficgen_integration_guide.rst b/docs/testing/developer/devguide/design/trafficgen_integration_guide.rst
similarity index 100%
rename from docs/testing/developer/design/trafficgen_integration_guide.rst
rename to docs/testing/developer/devguide/design/trafficgen_integration_guide.rst

diff --git a/docs/testing/developer/design/vsperf.png b/docs/testing/developer/devguide/design/vsperf.png
similarity index 100%
rename from docs/testing/developer/design/vsperf.png
rename to docs/testing/developer/devguide/design/vsperf.png

diff --git a/docs/testing/developer/design/vswitchperf_design.rst b/docs/testing/developer/devguide/design/vswitchperf_design.rst
similarity index 100%
rename from docs/testing/developer/design/vswitchperf_design.rst
rename to docs/testing/developer/devguide/design/vswitchperf_design.rst

diff --git a/docs/testing/developer/index.rst b/docs/testing/developer/devguide/index.rst
similarity index 70%
rename from docs/testing/developer/index.rst
rename to docs/testing/developer/devguide/index.rst
index cdda1d9..4ae155f 100644 (file)
--- a/docs/testing/developer/index.rst
+++ b/docs/testing/developer/devguide/index.rst
@@ -4,9 +4,13 @@
 
 .. OPNFV VSPERF Documentation master file.
 
-======
-VSPERF
-======
+****************************
+OPNFV VSPERF Developer Guide
+****************************
+
+============
+Introduction
+============
 
 VSPERF is an OPNFV testing project.
 
@@ -28,15 +32,14 @@ setup of the network and/or for control of the test-generator and test execution
 * Artifacts: https://artifacts.opnfv.org/vswitchperf.html
 * Continuous Integration status: https://build.opnfv.org/ci/view/vswitchperf/
 
-
-****************************
-VSPERF Developer Guide
-****************************
+=============
+Design Guides
+=============
 
 .. toctree::
    :caption: Traffic Gen Integration, VSPERF Design, Test Design, Test Plan
    :maxdepth: 2
-   :numbered: 2
+   :numbered:
 
    ./design/trafficgen_integration_guide.rst
    ./design/vswitchperf_design.rst
@@ -44,25 +47,31 @@ VSPERF Developer Guide
    ./requirements/vswitchperf_ltd.rst
    ./requirements/vswitchperf_ltp.rst
 
-*****************************
-VSPERF IETF Internet Draft
-*****************************
+====================
+VSPERF IETF RFC 8204
+====================
 
 .. toctree::
    :caption: vSwitch Internet Draft
    :maxdepth: 2
    :numbered:
 
-This IETF INternet Draft on `Benchmarking Virtual Switches in OPNFV <https://tools.ietf.org/html/draft-ietf-bmwg-vswitch-opnfv-01>`_ was developed by VSPERF contributors and is  maintained in the IETF repo. at https://tools.ietf.org/html/
+The VSPERF test specification was summarized in a 23 page Internet Draft ... `Benchmarking Virtual Switches in OPNFV
+<https://tools.ietf.org/html/draft-ietf-bmwg-vswitch-opnfv-01>`_
+ which was contributed to the IETF Benchmarking Methodology Working Group (BMWG). The BMWG was re-chartered in 2014
+to include benchmarking for Virtualized Network Functions (VNFs) and their infrastructure. The Internet Engineering
+Steering Group of the IETF has approved the most recent version for publication as RFC 8204.
 
-********************************
-VSPERF Scenarios and CI Results
-********************************
+====================
+VSPERF CI Test Cases
+====================
 
 .. toctree::
    :caption: VSPERF Scenarios & Results
    :maxdepth: 2
    :numbered:
 
+CI Test cases run daily on the VSPERF Pharos POD for master and stable branches.
+
    ./results/scenario.rst
    ./results/results.rst

diff --git a/docs/testing/developer/requirements/LICENSE b/docs/testing/developer/devguide/requirements/LICENSE
similarity index 100%
rename from docs/testing/developer/requirements/LICENSE
rename to docs/testing/developer/devguide/requirements/LICENSE

diff --git a/docs/testing/developer/requirements/ietf_draft/LICENSE b/docs/testing/developer/devguide/requirements/ietf_draft/LICENSE
similarity index 100%
rename from docs/testing/developer/requirements/ietf_draft/LICENSE
rename to docs/testing/developer/devguide/requirements/ietf_draft/LICENSE

diff --git a/docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml b/docs/testing/developer/devguide/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml
similarity index 100%
rename from docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-00.xml
rename to docs/testing/developer/devguide/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/testing/developer/devguide/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml
similarity index 100%
rename from docs/testing/developer/requirements/ietf_draft/draft-ietf-bmwg-vswitch-opnfv-01.xml
rename to docs/testing/developer/devguide/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/testing/developer/devguide/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml
similarity index 100%
rename from docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-00.xml
rename to docs/testing/developer/devguide/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/testing/developer/devguide/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml
similarity index 100%
rename from docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-01.xml
rename to docs/testing/developer/devguide/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/testing/developer/devguide/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml
similarity index 100%
rename from docs/testing/developer/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml
rename to docs/testing/developer/devguide/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml

diff --git a/docs/testing/developer/requirements/vm2vm_alternative_benchmark.png b/docs/testing/developer/devguide/requirements/vm2vm_alternative_benchmark.png
similarity index 100%
rename from docs/testing/developer/requirements/vm2vm_alternative_benchmark.png
rename to docs/testing/developer/devguide/requirements/vm2vm_alternative_benchmark.png

diff --git a/docs/testing/developer/requirements/vm2vm_benchmark.png b/docs/testing/developer/devguide/requirements/vm2vm_benchmark.png
similarity index 100%
rename from docs/testing/developer/requirements/vm2vm_benchmark.png
rename to docs/testing/developer/devguide/requirements/vm2vm_benchmark.png

diff --git a/docs/testing/developer/requirements/vm2vm_hypervisor_benchmark.png b/docs/testing/developer/devguide/requirements/vm2vm_hypervisor_benchmark.png
similarity index 100%
rename from docs/testing/developer/requirements/vm2vm_hypervisor_benchmark.png
rename to docs/testing/developer/devguide/requirements/vm2vm_hypervisor_benchmark.png

diff --git a/docs/testing/developer/requirements/vm2vm_virtual_interface_benchmark.png b/docs/testing/developer/devguide/requirements/vm2vm_virtual_interface_benchmark.png
similarity index 100%
rename from docs/testing/developer/requirements/vm2vm_virtual_interface_benchmark.png
rename to docs/testing/developer/devguide/requirements/vm2vm_virtual_interface_benchmark.png

diff --git a/docs/testing/developer/requirements/vswitchperf_ltd.rst b/docs/testing/developer/devguide/requirements/vswitchperf_ltd.rst
similarity index 100%
rename from docs/testing/developer/requirements/vswitchperf_ltd.rst
rename to docs/testing/developer/devguide/requirements/vswitchperf_ltd.rst

diff --git a/docs/testing/developer/requirements/vswitchperf_ltp.rst b/docs/testing/developer/devguide/requirements/vswitchperf_ltp.rst
similarity index 100%
rename from docs/testing/developer/requirements/vswitchperf_ltp.rst
rename to docs/testing/developer/devguide/requirements/vswitchperf_ltp.rst

diff --git a/docs/testing/developer/results/index.rst b/docs/testing/developer/devguide/results/index.rst
similarity index 100%
rename from docs/testing/developer/results/index.rst
rename to docs/testing/developer/devguide/results/index.rst

diff --git a/docs/testing/developer/results/results.rst b/docs/testing/developer/devguide/results/results.rst
similarity index 100%
rename from docs/testing/developer/results/results.rst
rename to docs/testing/developer/devguide/results/results.rst

diff --git a/docs/testing/developer/results/scenario.rst b/docs/testing/developer/devguide/results/scenario.rst
similarity index 100%
rename from docs/testing/developer/results/scenario.rst
rename to docs/testing/developer/devguide/results/scenario.rst

diff --git a/docs/testing/user/configguide/index.rst b/docs/testing/user/configguide/index.rst
index a7df2eb..bfeb0d2 100644 (file)
--- a/docs/testing/user/configguide/index.rst
+++ b/docs/testing/user/configguide/index.rst
@@ -4,9 +4,13 @@
 
 .. OPNFV VSPERF Documentation master file.
 
-======
-VSPERF
-======
+***********************************
+VSPERF Configuration and User Guide
+***********************************
+
+============
+Introduction
+============
 
 VSPERF is an OPNFV testing project.
 
@@ -28,12 +32,12 @@ setup of the network and/or for control of the test-generator and test execution
 * Artifacts: https://artifacts.opnfv.org/vswitchperf.html
 * Continuous Integration status: https://build.opnfv.org/ci/view/vswitchperf/
 
-******************************
-VSPERF User Guide
-******************************
+================================
+VSPERF Install and Configuration
+================================
 
 .. toctree::
-   :caption: VSPERF Install, Upgrade, Traffic Generator Guide, Test Suite Guide
+   :caption: VSPERF Install, Upgrade, Traffic Generator Guide
    :maxdepth: 2
    :numbered:
 
@@ -41,6 +45,15 @@ VSPERF User Guide
    ./upgrade.rst
    ./trafficgen.rst
 
+=================
+VSPERF Test Guide
+=================
+
+.. toctree::
+   :caption: VSPERF Test Execution
+   :maxdepth: 2
+   :numbered:
+
    ../userguide/testusage.rst
    ../userguide/teststeps.rst
    ../userguide/integration.rst