summaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide/overview.rst
diff options
context:
space:
mode:
authorYujun Zhang <zhang.yujunz@zte.com.cn>2017-03-30 10:14:04 +0800
committerYujun Zhang <zhang.yujunz@zte.com.cn>2017-03-30 22:21:39 +0800
commit0c8fdfafa8a85dd6e25497a9f9af9694e75ee4a1 (patch)
tree3d17ef62ada3fb9c756d9880fa4471c49fa320fd /docs/testing/user/userguide/overview.rst
parent88f69a8d9977228a225333f084dc95adc2312f13 (diff)
Normalize all section headers
- folder with `index.rst` for parts, using # with overline for heading - `*.rst` file for chapter, using * with overline for heading In each *.rst file, use the following token for heading - =, for sections - -, for subsections - ^, for subsubsections - ", for paragraphs Change-Id: I6c247c1f1e27e891d0dade099195ef521f7dbb72 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
Diffstat (limited to 'docs/testing/user/userguide/overview.rst')
-rw-r--r--docs/testing/user/userguide/overview.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/testing/user/userguide/overview.rst b/docs/testing/user/userguide/overview.rst
index 1ad0b670..726d70bc 100644
--- a/docs/testing/user/userguide/overview.rst
+++ b/docs/testing/user/userguide/overview.rst
@@ -3,9 +3,9 @@
.. (c) 2017 ZTE Corp.
-############
-Introduction
-############
+********
+Overview
+********
`QTIP`_ is the project for **Platform Performance Benchmarking** in `OPNFV`_. It aims to provide user a simple indicator
for performance, simple but supported by comprehensive testing data and transparent calculation formula.
@@ -18,9 +18,9 @@ performance. **TRUE** reflects the core value of QPI in four aspects
- *Understandable*: QPI is broke down into section scores, and workload scores in report to help user to understand
- *Extensible*: users may create their own QPI by composing the existed metrics in QTIP or extend new metrics
-##########
+
Benchmarks
-##########
+==========
The builtin benchmarks of QTIP are located in ``<package_root>/benchmarks`` folder