aboutsummaryrefslogtreecommitdiffstats
path: root/docs/all/index.rst
diff options
context:
space:
mode:
authorMaryam Tahhan <maryam.tahhan@intel.com>2015-12-02 13:42:50 +0000
committerMaryam Tahhan <maryam.tahhan@intel.com>2015-12-21 10:44:07 +0000
commitcc3a4bf85074989c28a09b7b141dea5e42701f5c (patch)
tree18740fd268ff0d631812b36eb45636489cf8b75d /docs/all/index.rst
parentde0aaffe31e1f787cefe21a5957a07924bb5956f (diff)
docs: updates and move traffic gens to separate doc
Move the traffic gen instructions to a separate user guide and add information on usage of the Dummy traffic generator. Update docs to fix PDF build failure and do general clean-up. Removed the numbering from the LTD and added the numbered directive to automate numbering for sections and headers. Add comment anchors that reflect the section numbers. Change-Id: I984ca38456a891c439697ebc1da041bc1d828a15 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
Diffstat (limited to 'docs/all/index.rst')
-rwxr-xr-xdocs/all/index.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/all/index.rst b/docs/all/index.rst
new file mode 100755
index 00000000..5032b00c
--- /dev/null
+++ b/docs/all/index.rst
@@ -0,0 +1,33 @@
+.. OPNFV VSPERF Documentation master file.
+
+======
+VSPERF
+======
+Welcome to VSPERF's documentation !
+
+.. _VSPERF: https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases
+.. _REPO: https://gerrit.opnfv.org/gerrit/#/q/vswitchperf
+
+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.
+
+.. toctree::
+ :maxdepth: 3
+ :numbered: 5
+
+ User Guides <http://artifacts.opnfv.org/vsperf/docs/userguides/index.html>
+ Design <http://artifacts.opnfv.org/vswitchperf/docs/designindex.html>
+ Test Specification <http://artifacts.opnfv.org/vswitchperf/docs/requirements/index.html>
+ Release Information <http://artifacts.opnfv.org/vswitchperf/docs/release/index.html>
+
+
+Indices
+=======
+* :ref:`search`
+