Adjust the structure of doctor/userguide dir

Change-Id: Ie526d921dabbfa3b7a9c95f1705390c2eef53998
Signed-off-by: Julien <zhang.jun3g@zte.com.cn>
Signed-off-by: Yuanzhen Li <li.yuanzhen@zte.com.cn>
(cherry picked from commit 9064b1fc9960f5a808a8e71158e492f4c31edf05)

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100755 (executable)
index 0000000..a834997
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,24 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2016 OPNFV.
+
+
+======
+Doctor
+======
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+
+   ./installationprocedure/index.rst
+   ./design/index.rst
+   ./manuals/index.rst
+   ./requirements/index.rst
+   ./scenarios/index.rst
+   ./userguide/index.rst
+
+Indices
+=======
+* :ref:`search`
+

diff --git a/docs/platformoverview/platformoverview.rst b/docs/platformoverview/platformoverview.rst
deleted file mode 100644 (file)
index 8a15123..0000000
--- a/docs/platformoverview/platformoverview.rst
+++ /dev/null
@@ -1,60 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Doctor platform components and features
-=======================================
-
-..
-    This section will be compiled into OPNFV composite document.
-
-https://wiki.opnfv.org/doctor
-
-Features
---------
-
-Doctor platform provides these features in `Colorado Release <https://wiki.opnfv.org/display/SWREL/Colorado>`_:
-
-* Immediate Notification
-* Consistent resource state awareness for compute host down
-* Valid compute host status given to VM owner
-
-These features enable high availability of Network Services on top of
-the virtualized infrastructure.
-
-Immediate notification allows VNF managers (VNFM) to process recovery
-actions promptly once a failure has occurred.
-
-Consistency of resource state is necessary to properly execute recovery
-actions properly in the VIM.
-
-Ability to query host status gives VM owner (VNFM) the possibility to get
-consistent state information through an API in case of a compute host
-fault.
-
-Components
-----------
-
-Doctor platform, as of Colorado release, consists of the following
-components:
-
-* OpenStack Compute (Nova)
-* OpenStack Telemetry (Ceilometer)
-* OpenStack Alarming (Aodh)
-* Doctor Inspector
-* Doctor Monitor
-
-.. note::
-    Doctor Inspector and Monitor are sample implementation for reference.
-
-You can see an overview of the Doctor platform and how components interact in
-:numref:`figure-p1`.
-
-.. figure:: images/figure-p1.png
-    :name: figure-p1
-    :width: 100%
-
-    Doctor platform and typical sequence (Colorado)
-
-Detailed information on the Doctor architecture can be found in the Doctor
-requirements documentation:
-http://artifacts.opnfv.org/doctor/docs/requirements/05-implementation.html

diff --git a/docs/userguide/doctor_scenario_in_functest.rst b/docs/scenarios/functest/doctor-scenario-in-functest.rst
similarity index 96%
rename from docs/userguide/doctor_scenario_in_functest.rst
rename to docs/scenarios/functest/doctor-scenario-in-functest.rst
index b36937e..29af739 100644 (file)
--- a/docs/userguide/doctor_scenario_in_functest.rst
+++ b/docs/scenarios/functest/doctor-scenario-in-functest.rst
@@ -1,8 +1,7 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-Doctor
-^^^^^^
+
 
 Platform overview
 """""""""""""""""
@@ -38,7 +37,7 @@ The Doctor platform consists of the following components:
 You can see an overview of the Doctor platform and how components interact in
 :numref:`figure-p1`.
 
-.. figure:: /platformoverview/images/figure-p1.png
+.. figure:: ./images/figure-p1.png
     :name: figure-p1
     :width: 100%
 
@@ -46,8 +45,7 @@ You can see an overview of the Doctor platform and how components interact in
 
 Detailed information on the Doctor architecture can be found in the Doctor
 requirements documentation:
-http://artifacts.opnfv.org/doctor/docs/requirements/05-implementation.html
-
+http://artifacts.opnfv.org/doctor/colorado/requirements/05-implementation.html
 
 Use case
 """"""""

diff --git a/docs/platformoverview/images/LICENSE b/docs/scenarios/functest/images/LICENSE
similarity index 100%
rename from docs/platformoverview/images/LICENSE
rename to docs/scenarios/functest/images/LICENSE

diff --git a/docs/platformoverview/images/figure-p1.png b/docs/scenarios/functest/images/figure-p1.png
similarity index 100%
rename from docs/platformoverview/images/figure-p1.png
rename to docs/scenarios/functest/images/figure-p1.png

diff --git a/docs/platformoverview/index.rst b/docs/scenarios/index.rst
similarity index 62%
rename from docs/platformoverview/index.rst
rename to docs/scenarios/index.rst
index 23d61cd..3732e02 100644 (file)
--- a/docs/platformoverview/index.rst
+++ b/docs/scenarios/index.rst
@@ -1,12 +1,12 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-************************
-Doctor Platform Overview
-************************
+===============
+Doctor scenario
+===============
 
 .. toctree::
     :maxdepth: 2
     :numbered:
 
-.. include:: platformoverview.rst
+   ./functest/doctor-scenario-in-functest.rst