aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorFatih Degirmenci <fatih.degirmenci@ericsson.com>2015-12-03 14:13:16 +0100
committerFatih Degirmenci <fatih.degirmenci@ericsson.com>2015-12-03 14:18:00 +0100
commitbd3d1c0ebdc2ed8e9918b7e462a6994468a46d0a (patch)
treee56edd70b285383bf107316663f669cc2a570a12 /docs/index.rst
parent2f7f80ef210977f4ca30056fc9852b8ea4242cca (diff)
Remove etc and source folder from yardstick documentation
conf.py and logo will come from releng which is common for all projects. The directory structure in docs folder has not been decided yet so this change does not require you to change your current way of working. Once this directory structure is decided by opnfvdocs and releng, the changes need to be reflected back to all projects, including yardstick. Change-Id: If0558474a819f4a44e34f790d26c5486751b8266 Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst52
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 000000000..36a78321a
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,52 @@
+.. OPNFV Yardstick documentation master file.
+ Add chapters and user guides using the
+ root `toctree` directive.
+
+=================
+Yardstick Project
+=================
+
+Welcome to Yardstick's documentation !
+
+.. _Yardstick: https://wiki.opnfv.org/yardstick
+
+Yardstick_ is an OPNFV testing project.
+
+The project goal is to verify infrastructure compliance, from the perspective
+of a VNF.
+
+The project scope is the development of a test framework, test cases and test
+stimuli.
+
+This document introduces the methodology applied in Yardstick_ project, which
+decomposes typical VNF work-load performance metrics into a number of
+characteristics/performance vectors, each of them can be represented by
+distinct test-cases.
+
+The user guides and test cases delivered for the release are included.
+
+Contents:
+
+Yardstick Project Description
+=============================
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+User Guides
+===========
+
+.. toctree::
+ :maxdepth: 1
+
+ user_guides/framework/03-installation
+
+Indices
+=======
+
+* :ref:`search`
+
+Revision: _sha1_
+
+Build date: |today|