project document refactoring

JIRA: BOTTLENECK-88

Change-Id: I393987a9c1711d25585819176ee9b014a713cf4a
Signed-off-by: MatthewLi <matthew.lijun@huawei.com>

diff --git a/docs/bottlenecks_brahmaputra_docs/index.rst b/docs/bottlenecks_brahmaputra_docs/index.rst
deleted file mode 100644 (file)
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 (file)
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
similarity index 100%
rename from docs/bottlenecks_brahmaputra_docs/configguide/introduction.rst
rename to docs/configguide/introduction.rst

diff --git a/docs/bottlenecks_brahmaputra_docs/images/example.png b/docs/images/example.png
similarity index 100%
rename from docs/bottlenecks_brahmaputra_docs/images/example.png
rename to docs/images/example.png

diff --git a/docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_test_result.rst b/docs/templates/bottlenecks_test_result.rst
similarity index 100%
rename from docs/bottlenecks_brahmaputra_docs/templates/bottlenecks_test_result.rst
rename to docs/templates/bottlenecks_test_result.rst

diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
new file mode 100644 (file)
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
similarity index 100%
rename from docs/bottlenecks_brahmaputra_docs/userguide/rubbos/rubbos_installation.rst
rename to 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
similarity index 100%
rename from docs/bottlenecks_brahmaputra_docs/userguide/vstf/vstf_installation.rst
rename to docs/userguide/vstf/vstf_installation.rst