Merge "install: Ubuntu 16.xx support"

[vswitchperf.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index bb0a698..37e0c43 100755 (executable)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,30 +1,37 @@
-.. OPNFV Release Engineering documentation, created by
-   sphinx-quickstart on Tue Jun  9 19:12:31 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+.. 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.
 
-.. image:: etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
+.. OPNFV VSPERF Documentation master file.
 
+======
 VSPERF
-=======================================
+======
+VSPERF is an OPNFV testing project.
 
-Contents:
+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: 4
-   :titlesonly:
-
-   guides/index
-   design/index
-   test_spec/index
-   updates/index
+* 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
+   ./results/index.rst
+
+Indices
+=======
 * :ref:`search`
 
-Revision: _sha1_
-
-Build date: |today|