summaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide/01-introduction.rst
diff options
context:
space:
mode:
authorJingLu5 <lvjing5@huawei.com>2017-03-28 01:43:21 +0000
committerJingLu5 <lvjing5@huawei.com>2017-03-30 08:42:15 +0000
commit2347f3977823bfd0c4b1fa832d9046b8a625596b (patch)
tree006d974d919cab8dfe3a33fffac86435de661148 /docs/testing/user/userguide/01-introduction.rst
parent4c1b439ccd286dc8c8a84cd8eed57d1b230c6177 (diff)
Refine documentation
Change-Id: I0d3387a520e3decf51bb0f7db53996f148a611d0 Signed-off-by: JingLu5 <lvjing5@huawei.com>
Diffstat (limited to 'docs/testing/user/userguide/01-introduction.rst')
-rwxr-xr-xdocs/testing/user/userguide/01-introduction.rst32
1 files changed, 19 insertions, 13 deletions
diff --git a/docs/testing/user/userguide/01-introduction.rst b/docs/testing/user/userguide/01-introduction.rst
index 2aa870c2a..4fc94ac62 100755
--- a/docs/testing/user/userguide/01-introduction.rst
+++ b/docs/testing/user/userguide/01-introduction.rst
@@ -12,6 +12,7 @@ Introduction
.. _Pharos: https://wiki.opnfv.org/pharos
.. _Yardstick: https://wiki.opnfv.org/yardstick
.. _Presentation: https://wiki.opnfv.org/download/attachments/2925202/opnfv_summit_-_yardstick_project.pdf?version=1&modificationDate=1458848320000&api=v2
+
Yardstick_ is an OPNFV Project.
The project's goal is to verify infrastructure compliance, from the perspective
@@ -37,14 +38,14 @@ About This Document
This document consists of the following chapters:
-* Chapter :doc:`01-introduction` provides a brief introduction to yardstick
- project's goal and scope and gives the structure of this document.
+* Chapter :doc:`01-introduction` provides a brief introduction to *Yardstick*
+ project's background and describes the structure of this document.
* Chapter :doc:`02-methodology` describes the methodology implemented by the
- Yardstick Project for :term:`NFVI` verification.
+ *Yardstick* Project for :term:`NFVI` verification.
* Chapter :doc:`03-architecture` provides information on the software architecture
- of yardstick.
+ of *Yardstick*.
* Chapter :doc:`04-installation` provides instructions to install *Yardstick*.
@@ -54,22 +55,28 @@ This document consists of the following chapters:
* Chapter :doc:`06-result-store-InfluxDB` provides inforamtion on how to run
plug-in test cases and store test results into community's InfluxDB.
-* Chapter :doc:`07-vtc-overview` provides information on the :term:`VTC`.
+* Chapter :doc:`07-grafana` provides inforamtion on *Yardstick* grafana dashboard
+ and how to add a dashboard into *Yardstick* grafana dashboard.
+
+* Chapter :doc:`08-api` provides inforamtion on *Yardstick* ReST API and how to
+ use *Yardstick* API.
-* Chapter :doc:`08-apexlake_installation` provides instructions to install the
+* Chapter :doc:`09-vtc-overview` provides information on the :term:`VTC`.
+
+* Chapter :doc:`10-apexlake_installation` provides instructions to install the
experimental framework *ApexLake*
-* Chapter :doc:`09-apexlake_api` explains how this framework is integrated in
+* Chapter :doc:`11-apexlake_api` explains how this framework is integrated in
*Yardstick*.
-* Chapter :doc:`10-nsb-overview` describes the methodology implemented by the
- yardstick - Network service benchmarking to test real world usecase for a
- given VNF
+* Chapter :doc:`12-nsb-overview` describes the methodology implemented by the
+ Yardstick - Network service benchmarking to test real world usecase for a
+ given VNF.
-* Chapter :doc:`11-nsb_installation` provides instructions to install
+* Chapter :doc:`13-nsb_installation` provides instructions to install
*Yardstick - Network service benchmarking testing*.
-* Chapter :doc:`12-list-of-tcs` includes a list of available Yardstick test
+* Chapter :doc:`14-list-of-tcs` includes a list of available *Yardstick* test
cases.
@@ -79,4 +86,3 @@ Contact Yardstick
Feedback? `Contact us`_
.. _Contact us: opnfv-users@lists.opnfv.org
-