summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorMaryam Tahhan <maryam.tahhan@intel.com>2016-01-25 10:58:47 +0000
committerMaryam Tahhan <maryam.tahhan@intel.com>2016-01-25 16:41:08 +0000
commit276d16fd75a717e5f5004e117cb9d3b18fd37363 (patch)
tree98381c5cd8cc76f67a04c38f67da01aaf8b9bf09 /docs/index.rst
parentcdda1e1aaaae6c22a592980cabd6f301d661f737 (diff)
docs: updates and final fixes
Migrate the installation guide for vsperf to a configguide directory, update the links to the installation guide. Re-add top level index.rst and remove the all directory. Update release documentation with vsperf Rel B support. Change-Id: Ib643b9d3581d8109b85c377027c8cc6be4b797fc Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Radek Zetik <radekx.zetik@intel.com> Reviewed-by: Dino Simeon Madarang <dino.simeonx.madarang@intel.com> Reviewed-by: Brian Castelli <brian.castelli@spirent.com>
Diffstat (limited to 'docs/index.rst')
-rwxr-xr-xdocs/index.rst36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100755
index 00000000..59323795
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,36 @@
+.. OPNFV VSPERF Documentation master file.
+
+======
+VSPERF
+======
+VSPERF is an OPNFV testing project.
+
+VSPERF will develop a generic and architecture agnostic vSwitch testing
+framework and associated tests, that will serve as a basis for validating the
+suitability of different vSwitch implementations in a Telco NFV deployment
+environment. The output of this project will be utilized by the OPNFV
+Performance and Test group and its associated projects, as part of OPNFV
+Platform and VNF level testing and validation.
+
+Project Wiki:
+https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases
+
+Project Repository: https://gerrit.opnfv.org/gerrit/#/q/vswitchperf
+
+Continuous Integration https://build.opnfv.org/ci/view/vswitchperf/
+
+.. toctree::
+ :maxdepth: 3
+ :numbered: 5
+
+ ./configguide/index.rst
+ ./userguide/index.rst
+ ./design/index.rst
+ ./requirements/index.rst
+ ./release/index.rst
+
+
+Indices
+=======
+* :ref:`search`
+