summaryrefslogtreecommitdiffstats
path: root/docs/configguide
diff options
context:
space:
mode:
authorMatthewLi <matthew.lijun@huawei.com>2016-07-28 03:29:14 -0400
committerMatthewLi <matthew.lijun@huawei.com>2016-07-28 03:30:09 -0400
commit2d8b1854dbf5e4f093f10a17abc6a2853746a03b (patch)
tree4f5063c6d7ca997eca6edae58f7efda778f0213f /docs/configguide
parent602354a46dcddfa0636ae8cf69044546b8ff437e (diff)
project document refactoring
JIRA: BOTTLENECK-88 Change-Id: I393987a9c1711d25585819176ee9b014a713cf4a Signed-off-by: MatthewLi <matthew.lijun@huawei.com>
Diffstat (limited to 'docs/configguide')
-rw-r--r--docs/configguide/index.rst12
-rw-r--r--docs/configguide/introduction.rst30
2 files changed, 42 insertions, 0 deletions
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
new file mode 100644
index 00000000..86c47645
--- /dev/null
+++ b/docs/configguide/index.rst
@@ -0,0 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+
+*****************************
+Bottlenecks - configureguide
+*****************************
+
+.. toctree::
+ :maxdepth: 2
+
+ ./introduction.rst
diff --git a/docs/configguide/introduction.rst b/docs/configguide/introduction.rst
new file mode 100644
index 00000000..cf002867
--- /dev/null
+++ b/docs/configguide/introduction.rst
@@ -0,0 +1,30 @@
+============
+Introduction
+============
+
+**Welcome to bottlenecks' documentation !**
+
+.. _Bottlenecks: https://wiki.opnfv.org/bottlenecks
+
+Bottlenecks_ is an OPNFV Project.
+
+The project's goal is to find system bottlenecks by testing and verifying
+OPNFV infrastructure in a staging environment before committing it to a production environment.
+Instead of debugging a deployment in production environment,
+an automatic method for executing benchmarks which plans to
+validate the deployment during staging is adopted.
+This project will provide frameworks to find the bottlenecks of OPNFV infrastructure.
+
+The *Bottlenecks* framework is deployed in several OPNFV community labs. It is
+installer, infrastructure and application independent.
+
+.. _Pharos: https://wiki.opnfv.org/pharos
+
+.. seealso:: Pharos_ for information on OPNFV community labs.
+
+Contact Bottlenecks
+===================
+
+Feedback? `Contact us`_
+
+.. _Contact us: opnfv-users@lists.opnfv.org