From: Bertrand Souville <souville@docomolab-euro.com>
Date: Wed, 24 Aug 2016 07:28:41 +0000 (+0200)
Subject: Minor changes to user guide
X-Git-Tag: colorado.1.0~7
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F43%2F19543%2F1;p=doctor.git

Minor changes to user guide
Removal of configguide directory
Corrected links

Change-Id: I74381f761b39a3db18ef9eee8555e1927ac9a326
Signed-off-by: Bertrand Souville <souville@docomolab-euro.com>
(cherry picked from commit c9653963c9a09c7002d4e274662426206923845c)
---

diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst
deleted file mode 100644
index 5ca17b9b..00000000
--- a/docs/configguide/featureconfig.rst
+++ /dev/null
@@ -1,49 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Doctor Configuration
-====================
-
-..
-    This section will be compiled into OPNFV composite document.
-
-Doctor Inspector
-----------------
-
-Doctor Inspector is suggested to be placed in one of the controller nodes,
-but it can be put on any host where Doctor Monitor can reach and accessible
-to the OpenStack Controller (Nova).
-
-Make sure OpenStack env parameters are set properly, so that Doctor Inspector
-can issue admin actions such as compute host force-down and state update of VM.
-
-Then, you can configure Doctor Inspector as follows:
-
-.. code-block:: bash
-
-    git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/brahmaputra
-    cd doctor/tests
-    INSPECTOR_PORT=12345
-    python inspector.py $INSPECTOR_PORT > inspector.log 2>&1 &
-
-Doctor Monitor
---------------
-
-Doctor Monitors are suggested to be placed in one of the controller nodes,
-but those can be put on any host which is reachable to target compute host and
-accessible to the Doctor Inspector.
-You need to configure Monitors for all compute hosts one by one.
-
-Make sure OpenStack env parameters are set properly, so that Doctor Inspector
-can issue admin actions such as compute host force-down and state update of VM.
-
-Then, you can configure Doctor Monitor as follows:
-
-.. code-block:: bash
-
-    git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/brahmaputra
-    cd doctor/tests
-    INSPECTOR_PORT=12345
-    COMPUTE_HOST='overcloud-novacompute-0'
-    sudo python monitor.py "$COMPUTE_HOST" \
-        "http://127.0.0.1:$INSPECTOR_PORT/events" > monitor.log 2>&1 &
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
deleted file mode 100644
index 4a7a5fbe..00000000
--- a/docs/configguide/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
-
-**************************
-Doctor Configuration Guide
-**************************
-
-.. toctree::
-    :maxdepth: 2
-    :numbered:
-
-.. include:: featureconfig.rst
diff --git a/docs/manuals/get-valid-server-state.rst b/docs/manuals/get-valid-server-state.rst
index 5d74e9ed..ed1c6d5c 100644
--- a/docs/manuals/get-valid-server-state.rst
+++ b/docs/manuals/get-valid-server-state.rst
@@ -119,7 +119,7 @@ Links:
 ======
 
 [1] Manual for OpenStack NOVA API for marking host down
-http://artifacts.opnfv.org/doctor/brahmaputra/docs/manuals/mark-host-down_manual.html
+http://artifacts.opnfv.org/doctor/colorado/manuals/mark-host-down_manual.html
 
 [2] OpenStack compute manual page
 http://developer.openstack.org/api-ref-compute-v2.1.html#compute-v2.1
diff --git a/docs/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst
index d24c1acb..4e080eb9 100644
--- a/docs/userguide/feature.userguide.rst
+++ b/docs/userguide/feature.userguide.rst
@@ -3,10 +3,6 @@
 
 Doctor capabilities and usage
 =============================
-
-..
-    This section will be compiled into OPNFV composite document.
-
 Immediate Notification
 ----------------------
 
@@ -21,7 +17,7 @@ repository. It can be executed as follows:
 
 .. code-block:: bash
 
-    git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/brahmaputra
+    git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/colorado
     cd doctor/tests
     CONSUMER_PORT=12346
     python consumer.py "$CONSUMER_PORT" > consumer.log 2>&1 &
@@ -34,7 +30,7 @@ from a monitor running outside of OpenStack Compute (Nova) by using
 force-down API.
 
 See
-http://artifacts.opnfv.org/doctor/brahmaputra/docs/manuals/mark-host-down_manual.html
+http://artifacts.opnfv.org/doctor/colorado/manuals/mark-host-down_manual.html
 for more detail.
 
 Valid compute host status given to VM owner
@@ -44,5 +40,5 @@ The resource state of a compute host can be retrieved by a user with the
 OpenStack Compute (Nova) servers API.
 
 See
-http://artifacts.opnfv.org/doctor/docs/manuals/get-valid-server-state.html
+http://artifacts.opnfv.org/doctor/colorado/manuals/get-valid-server-state.html
 for more detail.