diff options
author | Yujun Zhang <zhang.yujunz@zte.com.cn> | 2016-10-18 14:45:01 +0800 |
---|---|---|
committer | Yujun Zhang <zhang.yujunz@zte.com.cn> | 2016-10-18 14:45:01 +0800 |
commit | fc7bfe32ca05a9fa70e49cd7b1571940d9320d2c (patch) | |
tree | f695c3bb76a93d7cb3f50d59749389a7df1dc551 /docs/overview | |
parent | c65405d9073cc92fbab5485089cd962a0638d8ac (diff) |
Reorganize existing documents
- Align document structure with Colorado release
- follow convention used in "Python’s Style Guide for documentating"[1]
[1] https://docs.python.org/devguide/documenting.html#sections
Change-Id: Idee6ad6e68a35e3fd84ec36de480722e0259011b
JIRA: QTIP-117
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
Diffstat (limited to 'docs/overview')
-rw-r--r-- | docs/overview/index.rst | 13 | ||||
-rw-r--r-- | docs/overview/overview.rst | 21 |
2 files changed, 34 insertions, 0 deletions
diff --git a/docs/overview/index.rst b/docs/overview/index.rst new file mode 100644 index 00000000..731b8d49 --- /dev/null +++ b/docs/overview/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 ZTE Corp. + + +===================== +QTIP Project Overview +===================== + +.. toctree:: + :maxdepth: 2 + + ./overview.rst diff --git a/docs/overview/overview.rst b/docs/overview/overview.rst new file mode 100644 index 00000000..aa09c7c3 --- /dev/null +++ b/docs/overview/overview.rst @@ -0,0 +1,21 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015 Dell Inc. +.. (c) 2016 ZTE Corp. + +======== +Overview +======== + +.. _QTIP: https://wiki.opnfv.org/platform_performance_benchmarking + +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. |