aboutsummaryrefslogtreecommitdiffstats
path: root/docs/how-to-use-docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs/how-to-use-docs')
-rw-r--r--docs/how-to-use-docs/01-introduction.rst30
-rw-r--r--docs/how-to-use-docs/index.rst1
2 files changed, 31 insertions, 0 deletions
diff --git a/docs/how-to-use-docs/01-introduction.rst b/docs/how-to-use-docs/01-introduction.rst
new file mode 100644
index 00000000..74587e81
--- /dev/null
+++ b/docs/how-to-use-docs/01-introduction.rst
@@ -0,0 +1,30 @@
+============
+Introduction
+============
+
+**Welcome to QTIP's documentation !**
+
+.. _QTIP: https://wiki.opnfv.org/yardstick
+
+QTIP_ is an OPNFV Project.
+
+QTIP aims to benchmark OPNFV platforms through a "Bottom up" approach, testing bare-metal components first.
+
+The overall problem this project tries to solve is the general characterization of an OPNFV platform. It will focus on general performance questions that are common to the platform itself, or applicable to multiple OPNFV use cases. QTIP will provide the capability to quantify a platform's performance behavior in a standardized, rigorous, and open way, and a well-documented methodology to reproduce the results by anyone interested.
+
+The chapter :doc:`02-methodology` describes the methodology implemented by the
+QTIP Project for NFVI performance benchmarking. The chapter
+:doc:`03-list-of-testcases` includes a list of available Yardstick test cases.
+
+The *QTIP* framework is deployed in the Dell OPNFV community lab. It is
+infrastructure and application independent.
+
+.. _Pharos: https://wiki.opnfv.org/pharos
+.. seealso:: Pharos_ for information on OPNFV community labs.
+
+Contact QTIP
+=================
+
+Feedback? `Contact us`_
+
+.. _Contact us: opnfv-users@lists.opnfv.org
diff --git a/docs/how-to-use-docs/index.rst b/docs/how-to-use-docs/index.rst
index 36710b32..bbe991b0 100644
--- a/docs/how-to-use-docs/index.rst
+++ b/docs/how-to-use-docs/index.rst
@@ -19,6 +19,7 @@ Contents:
:maxdepth: 4
documentation-example.rst
+ 01-introduction.rst
Indices and tables
==================