xena_cont_learning: Adds learning preemption to continuous traffic
[vswitchperf.git] / docs / index.rst
index ec5176c..37e0c43 100755 (executable)
@@ -1,16 +1,37 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation, AT&T and others.
+
+.. 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: 4
-   :titlesonly:
+   :maxdepth: 3
+   :numbered: 5
 
-   guides/index
-   design/index
-   test_spec/index
-   updates/index
+   ./configguide/index.rst
+   ./userguide/index.rst
+   ./design/index.rst
+   ./requirements/index.rst
+   ./release/index.rst
+   ./results/index.rst
 
-Revision: _sha1_
+Indices
+=======
+* :ref:`search`
 
-Build date: |today|