summaryrefslogtreecommitdiffstats
path: root/docs
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
parent602354a46dcddfa0636ae8cf69044546b8ff437e (diff)
project document refactoring
JIRA: BOTTLENECK-88 Change-Id: I393987a9c1711d25585819176ee9b014a713cf4a Signed-off-by: MatthewLi <matthew.lijun@huawei.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/bottlenecks_brahmaputra_docs/index.rst15
-rw-r--r--docs/configguide/index.rst12
-rw-r--r--docs/configguide/introduction.rst (renamed from docs/bottlenecks_brahmaputra_docs/configguide/introduction.rst)0
-rw-r--r--docs/images/example.png (renamed from docs/bottlenecks_brahmaputra_docs/images/example.png)0
-rw-r--r--docs/templates/bottlenecks_test_result.rst (renamed from docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_test_result.rst)0
-rw-r--r--docs/userguide/index.rst15
-rw-r--r--docs/userguide/rubbos/rubbos_installation.rst (renamed from docs/bottlenecks_brahmaputra_docs/userguide/rubbos/rubbos_installation.rst)0
-rw-r--r--docs/userguide/vstf/vstf_installation.rst (renamed from docs/bottlenecks_brahmaputra_docs/userguide/vstf/vstf_installation.rst)0
8 files changed, 27 insertions, 15 deletions
diff --git a/docs/bottlenecks_brahmaputra_docs/index.rst b/docs/bottlenecks_brahmaputra_docs/index.rst
deleted file mode 100644
index 6eaabc1..0000000
--- a/docs/bottlenecks_brahmaputra_docs/index.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-*******************
-Bottlenecks Project
-*******************
-
-.. 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/configguide/index.rst b/docs/configguide/index.rst
new file mode 100644
index 0000000..86c4764
--- /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/bottlenecks_brahmaputra_docs/configguide/introduction.rst b/docs/configguide/introduction.rst
index cf00286..cf00286 100644
--- a/docs/bottlenecks_brahmaputra_docs/configguide/introduction.rst
+++ b/docs/configguide/introduction.rst
diff --git a/docs/bottlenecks_brahmaputra_docs/images/example.png b/docs/images/example.png
index e69de29..e69de29 100644
--- a/docs/bottlenecks_brahmaputra_docs/images/example.png
+++ b/docs/images/example.png
diff --git a/docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_test_result.rst b/docs/templates/bottlenecks_test_result.rst
index c566cdd..c566cdd 100644
--- a/docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_test_result.rst
+++ b/docs/templates/bottlenecks_test_result.rst
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
new file mode 100644
index 0000000..56330d3
--- /dev/null
+++ b/docs/userguide/index.rst
@@ -0,0 +1,15 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+**************************
+Bottlenecks - user guide
+**************************
+
+.. This index.rst file is used to structure and organise the content in these directories.
+.. The documentation toolchain will create web and pdf versions of the content of this file.
+
+.. toctree::
+ :maxdepth: 2
+
+ ./rubbos/rubbos_installation.rst
+ ./vstf/vstf_installation.rst
diff --git a/docs/bottlenecks_brahmaputra_docs/userguide/rubbos/rubbos_installation.rst b/docs/userguide/rubbos/rubbos_installation.rst
index 5b3583d..5b3583d 100644
--- a/docs/bottlenecks_brahmaputra_docs/userguide/rubbos/rubbos_installation.rst
+++ b/docs/userguide/rubbos/rubbos_installation.rst
diff --git a/docs/bottlenecks_brahmaputra_docs/userguide/vstf/vstf_installation.rst b/docs/userguide/vstf/vstf_installation.rst
index ad3ae39..ad3ae39 100644
--- a/docs/bottlenecks_brahmaputra_docs/userguide/vstf/vstf_installation.rst
+++ b/docs/userguide/vstf/vstf_installation.rst