summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authoryuyang <Gabriel.yuyang@huawei.com>2017-03-08 11:17:40 +0800
committeryuyang <Gabriel.yuyang@huawei.com>2017-03-09 19:09:27 +0800
commitbd80bcfb59a948d47af4d970f2832e8079f5f0f0 (patch)
tree5a0c9c9cfd1bb2bf2fa1dc6e7780f5538ebf3f85 /docs
parent5938133db9d2a4a8796c45eeeeef2c74da3ddeba (diff)
Apply docs strucutre to Danube agreement
JIRA: BOTTLENECK-137 According to the agreement in Testperf meeting. Change the structure of docs. Change-Id: Ie370de1e7a24c918aedc8a2cdb2cca0508ef4257 Signed-off-by: yuyang <Gabriel.yuyang@huawei.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/platform_overview/index.rst12
-rw-r--r--docs/release/index.rst (renamed from docs/release_notes/index.rst)6
-rw-r--r--docs/release/release-notes/release_notes.rst (renamed from docs/release_notes/release_notes.rst)0
-rw-r--r--docs/release/release-notes/requirements_notes.rst (renamed from docs/release_notes/requirements_notes.rst)0
-rw-r--r--docs/testing/developer/dashboard_guide.rst (renamed from docs/testing_guide/dashboard_guide.rst)0
-rw-r--r--docs/testing/developer/index.rst (renamed from docs/testing_guide/index.rst)0
-rw-r--r--docs/testing/developer/overview.rst (renamed from docs/testing_guide/overview.rst)0
-rw-r--r--docs/testing/developer/posca_guide.rst (renamed from docs/testing_guide/posca_guide.rst)0
-rw-r--r--docs/testing/developer/rubbos_guide.rst (renamed from docs/testing_guide/rubbos_guide.rst)0
-rw-r--r--docs/testing/developer/vstf_guide.rst (renamed from docs/testing_guide/vstf_guide.rst)0
-rw-r--r--docs/testing/index.rst (renamed from docs/platform_overview/introduction.rst)9
-rw-r--r--docs/testing/user/index.rst (renamed from docs/user_guide/index.rst)0
-rw-r--r--docs/testing/user/posca/posca_stress_ping.rst (renamed from docs/user_guide/posca/posca_stress_ping.rst)0
-rw-r--r--docs/testing/user/posca/posca_stress_traffic.rst (renamed from docs/user_guide/posca/posca_stress_traffic.rst)0
-rw-r--r--docs/testing/user/rubbos/rubbos_basic.rst (renamed from docs/user_guide/rubbos/rubbos_basic.rst)0
-rw-r--r--docs/testing/user/rubbos/rubbos_heavy_tc1101.rst (renamed from docs/user_guide/rubbos/rubbos_heavy_tc1101.rst)0
-rw-r--r--docs/testing/user/rubbos/rubbos_tc1101.rst (renamed from docs/user_guide/rubbos/rubbos_tc1101.rst)0
-rw-r--r--docs/testing/user/rubbos/rubbos_tc1201.rst (renamed from docs/user_guide/rubbos/rubbos_tc1201.rst)0
-rw-r--r--docs/testing/user/rubbos/rubbos_tc1301.rst (renamed from docs/user_guide/rubbos/rubbos_tc1301.rst)0
-rw-r--r--docs/testing/user/rubbos/rubbos_tc1401.rst (renamed from docs/user_guide/rubbos/rubbos_tc1401.rst)0
-rw-r--r--docs/testing/user/vstf/vstf_Ti1.rst (renamed from docs/user_guide/vstf/vstf_Ti1.rst)0
-rw-r--r--docs/testing/user/vstf/vstf_Ti2.rst (renamed from docs/user_guide/vstf/vstf_Ti2.rst)0
-rw-r--r--docs/testing/user/vstf/vstf_Ti3.rst (renamed from docs/user_guide/vstf/vstf_Ti3.rst)0
-rw-r--r--docs/testing/user/vstf/vstf_Tn1.rst (renamed from docs/user_guide/vstf/vstf_Tn1.rst)0
-rw-r--r--docs/testing/user/vstf/vstf_Tn2.rst (renamed from docs/user_guide/vstf/vstf_Tn2.rst)0
-rw-r--r--docs/testing/user/vstf/vstf_Tu1.rst (renamed from docs/user_guide/vstf/vstf_Tu1.rst)0
-rw-r--r--docs/testing/user/vstf/vstf_Tu2.rst (renamed from docs/user_guide/vstf/vstf_Tu2.rst)0
-rw-r--r--docs/testing/user/vstf/vstf_Tu3.rst (renamed from docs/user_guide/vstf/vstf_Tu3.rst)0
28 files changed, 12 insertions, 15 deletions
diff --git a/docs/platform_overview/index.rst b/docs/platform_overview/index.rst
deleted file mode 100644
index 81271a4..0000000
--- a/docs/platform_overview/index.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) Huawei Technologies Co.,Ltd and others.
-
-*******************************
-Bottlenecks - Platform Overview
-*******************************
-
-.. toctree::
- :maxdepth: 2
-
- ./introduction.rst
diff --git a/docs/release_notes/index.rst b/docs/release/index.rst
index 622671c..17e7844 100644
--- a/docs/release_notes/index.rst
+++ b/docs/release/index.rst
@@ -1,3 +1,4 @@
+.. _bottlenecks-releasenotes:
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) Huawei Technologies Co.,Ltd and others.
@@ -7,7 +8,6 @@ Bottlenecks - Release Notes
***************************
.. toctree::
- :maxdepth: 2
+ :glob:
- ./release_notes.rst
- ./requirements_notes.rst
+ release-notes/*
diff --git a/docs/release_notes/release_notes.rst b/docs/release/release-notes/release_notes.rst
index 76b5c1c..76b5c1c 100644
--- a/docs/release_notes/release_notes.rst
+++ b/docs/release/release-notes/release_notes.rst
diff --git a/docs/release_notes/requirements_notes.rst b/docs/release/release-notes/requirements_notes.rst
index 2660bb0..2660bb0 100644
--- a/docs/release_notes/requirements_notes.rst
+++ b/docs/release/release-notes/requirements_notes.rst
diff --git a/docs/testing_guide/dashboard_guide.rst b/docs/testing/developer/dashboard_guide.rst
index 5679e50..5679e50 100644
--- a/docs/testing_guide/dashboard_guide.rst
+++ b/docs/testing/developer/dashboard_guide.rst
diff --git a/docs/testing_guide/index.rst b/docs/testing/developer/index.rst
index 20cc00e..20cc00e 100644
--- a/docs/testing_guide/index.rst
+++ b/docs/testing/developer/index.rst
diff --git a/docs/testing_guide/overview.rst b/docs/testing/developer/overview.rst
index 8bc1b7c..8bc1b7c 100644
--- a/docs/testing_guide/overview.rst
+++ b/docs/testing/developer/overview.rst
diff --git a/docs/testing_guide/posca_guide.rst b/docs/testing/developer/posca_guide.rst
index dbc7568..dbc7568 100644
--- a/docs/testing_guide/posca_guide.rst
+++ b/docs/testing/developer/posca_guide.rst
diff --git a/docs/testing_guide/rubbos_guide.rst b/docs/testing/developer/rubbos_guide.rst
index 4d92d2e..4d92d2e 100644
--- a/docs/testing_guide/rubbos_guide.rst
+++ b/docs/testing/developer/rubbos_guide.rst
diff --git a/docs/testing_guide/vstf_guide.rst b/docs/testing/developer/vstf_guide.rst
index e1ad5f2..e1ad5f2 100644
--- a/docs/testing_guide/vstf_guide.rst
+++ b/docs/testing/developer/vstf_guide.rst
diff --git a/docs/platform_overview/introduction.rst b/docs/testing/index.rst
index cb85e61..70d3983 100644
--- a/docs/platform_overview/introduction.rst
+++ b/docs/testing/index.rst
@@ -23,6 +23,13 @@ This project forms a staging framework to find bottlenecks and to do analysis of
The *Bottlenecks* framework is deployed in several OPNFV community labs. It is
installer, infrastructure and application independent.
+.. toctree::
+ :glob:
+
+ developer/index.rst
+ user/index.rst
+ *
+
.. _Pharos: https://wiki.opnfv.org/pharos
.. seealso:: Pharos_ for information on OPNFV community labs.
@@ -35,3 +42,5 @@ Contact Bottlenecks
Feedback `Contact us`_
.. _Contact us: opnfv-users@lists.opnfv.org
+
+
diff --git a/docs/user_guide/index.rst b/docs/testing/user/index.rst
index 8afd57a..8afd57a 100644
--- a/docs/user_guide/index.rst
+++ b/docs/testing/user/index.rst
diff --git a/docs/user_guide/posca/posca_stress_ping.rst b/docs/testing/user/posca/posca_stress_ping.rst
index 846b468..846b468 100644
--- a/docs/user_guide/posca/posca_stress_ping.rst
+++ b/docs/testing/user/posca/posca_stress_ping.rst
diff --git a/docs/user_guide/posca/posca_stress_traffic.rst b/docs/testing/user/posca/posca_stress_traffic.rst
index a995996..a995996 100644
--- a/docs/user_guide/posca/posca_stress_traffic.rst
+++ b/docs/testing/user/posca/posca_stress_traffic.rst
diff --git a/docs/user_guide/rubbos/rubbos_basic.rst b/docs/testing/user/rubbos/rubbos_basic.rst
index ffef6c4..ffef6c4 100644
--- a/docs/user_guide/rubbos/rubbos_basic.rst
+++ b/docs/testing/user/rubbos/rubbos_basic.rst
diff --git a/docs/user_guide/rubbos/rubbos_heavy_tc1101.rst b/docs/testing/user/rubbos/rubbos_heavy_tc1101.rst
index 08251c7..08251c7 100644
--- a/docs/user_guide/rubbos/rubbos_heavy_tc1101.rst
+++ b/docs/testing/user/rubbos/rubbos_heavy_tc1101.rst
diff --git a/docs/user_guide/rubbos/rubbos_tc1101.rst b/docs/testing/user/rubbos/rubbos_tc1101.rst
index 2a26131..2a26131 100644
--- a/docs/user_guide/rubbos/rubbos_tc1101.rst
+++ b/docs/testing/user/rubbos/rubbos_tc1101.rst
diff --git a/docs/user_guide/rubbos/rubbos_tc1201.rst b/docs/testing/user/rubbos/rubbos_tc1201.rst
index 9b6a5f9..9b6a5f9 100644
--- a/docs/user_guide/rubbos/rubbos_tc1201.rst
+++ b/docs/testing/user/rubbos/rubbos_tc1201.rst
diff --git a/docs/user_guide/rubbos/rubbos_tc1301.rst b/docs/testing/user/rubbos/rubbos_tc1301.rst
index db4e0b6..db4e0b6 100644
--- a/docs/user_guide/rubbos/rubbos_tc1301.rst
+++ b/docs/testing/user/rubbos/rubbos_tc1301.rst
diff --git a/docs/user_guide/rubbos/rubbos_tc1401.rst b/docs/testing/user/rubbos/rubbos_tc1401.rst
index f195d23..f195d23 100644
--- a/docs/user_guide/rubbos/rubbos_tc1401.rst
+++ b/docs/testing/user/rubbos/rubbos_tc1401.rst
diff --git a/docs/user_guide/vstf/vstf_Ti1.rst b/docs/testing/user/vstf/vstf_Ti1.rst
index ce1690b..ce1690b 100644
--- a/docs/user_guide/vstf/vstf_Ti1.rst
+++ b/docs/testing/user/vstf/vstf_Ti1.rst
diff --git a/docs/user_guide/vstf/vstf_Ti2.rst b/docs/testing/user/vstf/vstf_Ti2.rst
index 58cb40f..58cb40f 100644
--- a/docs/user_guide/vstf/vstf_Ti2.rst
+++ b/docs/testing/user/vstf/vstf_Ti2.rst
diff --git a/docs/user_guide/vstf/vstf_Ti3.rst b/docs/testing/user/vstf/vstf_Ti3.rst
index 3bb9dfc..3bb9dfc 100644
--- a/docs/user_guide/vstf/vstf_Ti3.rst
+++ b/docs/testing/user/vstf/vstf_Ti3.rst
diff --git a/docs/user_guide/vstf/vstf_Tn1.rst b/docs/testing/user/vstf/vstf_Tn1.rst
index 5c591a9..5c591a9 100644
--- a/docs/user_guide/vstf/vstf_Tn1.rst
+++ b/docs/testing/user/vstf/vstf_Tn1.rst
diff --git a/docs/user_guide/vstf/vstf_Tn2.rst b/docs/testing/user/vstf/vstf_Tn2.rst
index 4b6d0c4..4b6d0c4 100644
--- a/docs/user_guide/vstf/vstf_Tn2.rst
+++ b/docs/testing/user/vstf/vstf_Tn2.rst
diff --git a/docs/user_guide/vstf/vstf_Tu1.rst b/docs/testing/user/vstf/vstf_Tu1.rst
index cf27bb2..cf27bb2 100644
--- a/docs/user_guide/vstf/vstf_Tu1.rst
+++ b/docs/testing/user/vstf/vstf_Tu1.rst
diff --git a/docs/user_guide/vstf/vstf_Tu2.rst b/docs/testing/user/vstf/vstf_Tu2.rst
index 2ae8446..2ae8446 100644
--- a/docs/user_guide/vstf/vstf_Tu2.rst
+++ b/docs/testing/user/vstf/vstf_Tu2.rst
diff --git a/docs/user_guide/vstf/vstf_Tu3.rst b/docs/testing/user/vstf/vstf_Tu3.rst
index 4e090f1..4e090f1 100644
--- a/docs/user_guide/vstf/vstf_Tu3.rst
+++ b/docs/testing/user/vstf/vstf_Tu3.rst