aboutsummaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide
diff options
context:
space:
mode:
authorJingLu5 <lvjing5@huawei.com>2017-03-30 11:50:02 +0000
committerJing Lu <lvjing5@huawei.com>2017-03-31 01:41:09 +0000
commitad7ff14ce6b6a30bb9276b904c528913fa3d2808 (patch)
tree9dea5e3f6318c8a1c249bc8d4fe4c8c35f32497e /docs/testing/user/userguide
parent3bbb75db603426d241cebd5425cb2b88fbd96a0c (diff)
add yardstick_user_interface chapter in userguide
JIRA: YARDSTICK-618 Change-Id: I690c24d665016a381ae1ed7d8fa94d5a34bc1b1b Signed-off-by: JingLu5 <lvjing5@huawei.com> (cherry picked from commit 0ce79677b81b47a7f66e43af896cfa9632da6bee)
Diffstat (limited to 'docs/testing/user/userguide')
-rwxr-xr-xdocs/testing/user/userguide/01-introduction.rst16
-rw-r--r--docs/testing/user/userguide/09-yardstick_user_interface.rst (renamed from docs/testing/user/userguide/Yardstick_user_interface.rst)0
-rw-r--r--docs/testing/user/userguide/10-vtc-overview.rst (renamed from docs/testing/user/userguide/09-vtc-overview.rst)0
-rw-r--r--docs/testing/user/userguide/11-apexlake_installation.rst (renamed from docs/testing/user/userguide/10-apexlake_installation.rst)0
-rw-r--r--docs/testing/user/userguide/12-apexlake_api.rst (renamed from docs/testing/user/userguide/11-apexlake_api.rst)0
-rw-r--r--docs/testing/user/userguide/13-nsb-overview.rst (renamed from docs/testing/user/userguide/12-nsb-overview.rst)0
-rw-r--r--docs/testing/user/userguide/14-nsb_installation.rst (renamed from docs/testing/user/userguide/13-nsb_installation.rst)0
-rw-r--r--docs/testing/user/userguide/15-list-of-tcs.rst (renamed from docs/testing/user/userguide/14-list-of-tcs.rst)0
-rw-r--r--docs/testing/user/userguide/index.rst13
9 files changed, 17 insertions, 12 deletions
diff --git a/docs/testing/user/userguide/01-introduction.rst b/docs/testing/user/userguide/01-introduction.rst
index 4fc94ac62..63d0d9883 100755
--- a/docs/testing/user/userguide/01-introduction.rst
+++ b/docs/testing/user/userguide/01-introduction.rst
@@ -61,22 +61,26 @@ This document consists of the following chapters:
* Chapter :doc:`08-api` provides inforamtion on *Yardstick* ReST API and how to
use *Yardstick* API.
-* Chapter :doc:`09-vtc-overview` provides information on the :term:`VTC`.
+* Chapter :doc:`09-yardstick_user_interface` provides inforamtion on how to use
+ yardstick report CLI to view the test result in table format and also values
+ pinned on to a graph
-* Chapter :doc:`10-apexlake_installation` provides instructions to install the
+* Chapter :doc:`10-vtc-overview` provides information on the :term:`VTC`.
+
+* Chapter :doc:`11-apexlake_installation` provides instructions to install the
experimental framework *ApexLake*
-* Chapter :doc:`11-apexlake_api` explains how this framework is integrated in
+* Chapter :doc:`12-apexlake_api` explains how this framework is integrated in
*Yardstick*.
-* Chapter :doc:`12-nsb-overview` describes the methodology implemented by the
+* Chapter :doc:`13-nsb-overview` describes the methodology implemented by the
Yardstick - Network service benchmarking to test real world usecase for a
given VNF.
-* Chapter :doc:`13-nsb_installation` provides instructions to install
+* Chapter :doc:`14-nsb_installation` provides instructions to install
*Yardstick - Network service benchmarking testing*.
-* Chapter :doc:`14-list-of-tcs` includes a list of available *Yardstick* test
+* Chapter :doc:`15-list-of-tcs` includes a list of available *Yardstick* test
cases.
diff --git a/docs/testing/user/userguide/Yardstick_user_interface.rst b/docs/testing/user/userguide/09-yardstick_user_interface.rst
index 9058dd46d..9058dd46d 100644
--- a/docs/testing/user/userguide/Yardstick_user_interface.rst
+++ b/docs/testing/user/userguide/09-yardstick_user_interface.rst
diff --git a/docs/testing/user/userguide/09-vtc-overview.rst b/docs/testing/user/userguide/10-vtc-overview.rst
index 8ed17873d..8ed17873d 100644
--- a/docs/testing/user/userguide/09-vtc-overview.rst
+++ b/docs/testing/user/userguide/10-vtc-overview.rst
diff --git a/docs/testing/user/userguide/10-apexlake_installation.rst b/docs/testing/user/userguide/11-apexlake_installation.rst
index 0d8ef143f..0d8ef143f 100644
--- a/docs/testing/user/userguide/10-apexlake_installation.rst
+++ b/docs/testing/user/userguide/11-apexlake_installation.rst
diff --git a/docs/testing/user/userguide/11-apexlake_api.rst b/docs/testing/user/userguide/12-apexlake_api.rst
index 35a1dbe3e..35a1dbe3e 100644
--- a/docs/testing/user/userguide/11-apexlake_api.rst
+++ b/docs/testing/user/userguide/12-apexlake_api.rst
diff --git a/docs/testing/user/userguide/12-nsb-overview.rst b/docs/testing/user/userguide/13-nsb-overview.rst
index faac61f08..faac61f08 100644
--- a/docs/testing/user/userguide/12-nsb-overview.rst
+++ b/docs/testing/user/userguide/13-nsb-overview.rst
diff --git a/docs/testing/user/userguide/13-nsb_installation.rst b/docs/testing/user/userguide/14-nsb_installation.rst
index 3eb17bbca..3eb17bbca 100644
--- a/docs/testing/user/userguide/13-nsb_installation.rst
+++ b/docs/testing/user/userguide/14-nsb_installation.rst
diff --git a/docs/testing/user/userguide/14-list-of-tcs.rst b/docs/testing/user/userguide/15-list-of-tcs.rst
index 1b5806cd9..1b5806cd9 100644
--- a/docs/testing/user/userguide/14-list-of-tcs.rst
+++ b/docs/testing/user/userguide/15-list-of-tcs.rst
diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst
index f99d868e9..8ac1c7bdb 100644
--- a/docs/testing/user/userguide/index.rst
+++ b/docs/testing/user/userguide/index.rst
@@ -21,11 +21,12 @@ Performance Testing User Guide (Yardstick)
06-result-store-InfluxDB
07-grafana
08-api
- 09-vtc-overview
- 10-apexlake_installation
- 11-apexlake_api
- 12-nsb-overview
- 13-nsb_installation
- 14-list-of-tcs
+ 09-yardstick_user_interface
+ 10-vtc-overview
+ 11-apexlake_installation
+ 12-apexlake_api
+ 13-nsb-overview
+ 14-nsb_installation
+ 15-list-of-tcs
glossary
references