diff options
| author |   MatthewLi <matthew.lijun@huawei.com> | 2016-01-18 02:59:18 -0500 |
|---|---|---|
| committer | MatthewLi <matthew.lijun@huawei.com> | 2016-01-18 20:24:46 -0500 |
| commit | 61b37f3955ba7abb168fc5bab53a336a20579286 (patch) | |
| tree | be2f0d572ebeb5a340a0cabca914160e9516e8f9 /docs/bottlenecks_brahmaputra_docs | |
| parent | 827a986f4abc404dc803380a25d5e9ade7448f67 (diff) | |
define the documents in bottlenecks
JIRA: BOTTLENECK-39
Change-Id: I4ed4e4831c8f7d20ae75f33d7c0f4d47600989b7
Signed-off-by: MatthewLi <matthew.lijun@huawei.com>
Diffstat (limited to 'docs/bottlenecks_brahmaputra_docs')
8 files changed, 104 insertions, 0 deletions
diff --git a/docs/bottlenecks_brahmaputra_docs/configguide/bottlenecks_definition.rst b/docs/bottlenecks_brahmaputra_docs/configguide/bottlenecks_definition.rst new file mode 100644 index 00000000..bed4255d --- /dev/null +++ b/docs/bottlenecks_brahmaputra_docs/configguide/bottlenecks_definition.rst @@ -0,0 +1,12 @@ +====================== +Bottlenecks Definition +====================== + +chapter 1 #replace this with your own name +=========================================== + +chapter 2 +========= + +chapter N +========= diff --git a/docs/bottlenecks_brahmaputra_docs/configguide/introduction.rst b/docs/bottlenecks_brahmaputra_docs/configguide/introduction.rst new file mode 100644 index 00000000..b46029ca --- /dev/null +++ b/docs/bottlenecks_brahmaputra_docs/configguide/introduction.rst @@ -0,0 +1,27 @@ +============ +Introduction +============ + +**Welcome to bottlenecks' documentation !** + +.. _Bottlenecks: https://wiki.opnfv.org/bottlenecks + +Bottlenecks_ is an OPNFV Project. + +The project's goal is + +The Project's scope is + +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 diff --git a/docs/bottlenecks_brahmaputra_docs/images/example.png b/docs/bottlenecks_brahmaputra_docs/images/example.png new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/docs/bottlenecks_brahmaputra_docs/images/example.png diff --git a/docs/bottlenecks_brahmaputra_docs/index.rst b/docs/bottlenecks_brahmaputra_docs/index.rst new file mode 100644 index 00000000..f6be0a41 --- /dev/null +++ b/docs/bottlenecks_brahmaputra_docs/index.rst @@ -0,0 +1,17 @@ +******************** +Bottlenecks Project +******************** + +Contents: + +.. toctree:: + :numbered: + :maxdepth: 5 + + configguide/introduction.rst + configguide/bottlenecks_definition.rst + images/example.png + userguide/rubbos/rubbos_installation.rst + userguide/vstf/vstf_installation.rst + templates/bottlenecks_test_result.rst + templates/bottlenecks_vstf_testcase_template.rst diff --git a/docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_test_result.rst b/docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_test_result.rst new file mode 100644 index 00000000..472bdfd3 --- /dev/null +++ b/docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_test_result.rst @@ -0,0 +1,19 @@ +======================== +Bottlenecks Test Report +======================== + + +Scope +===== +This document provides an overview of the results of test cases developed by +the OPNFV Bottlenecks Project, executed on OPNFV community labs. + +OPNFV CI(Continous Integration) system provides automated build, deploy and testing for +the software developed in OPNFV. Unless stated, the reported tests are +automated via Jenkins Jobs. + +Test results are visible in the following dashboard: + +* *Testing dashboard*: uses Mongo DB to store test results and Bitergia for + visualization, which includes the rubbos test result, vstf test result. + diff --git a/docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_vstf_testcase_template.rst b/docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_vstf_testcase_template.rst new file mode 100644 index 00000000..98dd7e09 --- /dev/null +++ b/docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_vstf_testcase_template.rst @@ -0,0 +1,3 @@ +================================== +Bottlenecks vstf testcase template +================================== diff --git a/docs/bottlenecks_brahmaputra_docs/userguide/rubbos/rubbos_installation.rst b/docs/bottlenecks_brahmaputra_docs/userguide/rubbos/rubbos_installation.rst new file mode 100644 index 00000000..0d4284a2 --- /dev/null +++ b/docs/bottlenecks_brahmaputra_docs/userguide/rubbos/rubbos_installation.rst @@ -0,0 +1,23 @@ +===================================== +Bottlenecks Rubbos Installation Guide +===================================== + + +Rubbos Introduction +==================== +framework description +to test what? + +Preinstall Packages +==================== +such as gettext + + +How is Rubbos Integrated into Installers +======================================== +1.community CI system +2.local + +Test Result Description +======================= +throughput, bottlenecks point description diff --git a/docs/bottlenecks_brahmaputra_docs/userguide/vstf/vstf_installation.rst b/docs/bottlenecks_brahmaputra_docs/userguide/vstf/vstf_installation.rst new file mode 100644 index 00000000..45db9d34 --- /dev/null +++ b/docs/bottlenecks_brahmaputra_docs/userguide/vstf/vstf_installation.rst @@ -0,0 +1,3 @@ +=================================== +Bottlenecks Vstf Installation Guide +=================================== |
