change the written way of the doc

JIRA: BOTTLENECK-23

document improvement

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

diff --git a/utils/infra_setup/README.rst b/utils/infra_setup/README.rst
index b6076eb..0b6dc40 100644 (file)
--- a/utils/infra_setup/README.rst
+++ b/utils/infra_setup/README.rst
@@ -1,4 +1,12 @@
-==================
+..
+.. image:: ../etc/opnfv-logo.png
+  :height: 40
+  :width: 200
+  :alt: OPNFV
+  :align: left
+..
+|
+|

 Infra Setup Guide
 ==================
 
 Infra Setup Guide
 ==================
 


@@ -28,27 +36,33 @@ Parameter $OPENRC_PATH is the path of where your admin-openrc.sh located, which
 Add Floating IPs for the Instances
 ===================================
 
 Add Floating IPs for the Instances
 ===================================
 

-Check the available floating IPs::
+Check the available floating IPs
+
+.. code-block:: bash
+
+    nova floating-ip-list
+
+Check the status of the instances created

 
 

- nova floating-ip-list
+.. code-block:: bash

 
 

-Check the status of the instances created::
+    nova list

 
 

- nova list
+If there're no available floating IPs, to create one

 
 

-If there're no available floating IPs, to create one::
+.. code-block:: bash

 
 

- nova floating-ip-create <ext_net_name>
+    nova floating-ip-create <ext_net_name>

 
 replace <ext_net_name> with the external network in your environment.
 
 
 replace <ext_net_name> with the external network in your environment.
 

-Associate the floating IP address with the instance::
+Associate the floating IP address with the instance

 
 

- nova add-floating-ip <instance name or ID> <allocated_floating_IP>
+.. code-block:: bash

 
 

+    nova add-floating-ip <instance name or ID> <allocated_floating_IP>

 
 

-**Documentation tracking**

 
 Revision: _sha1_
 
 
 Revision: _sha1_
 

-Build date:  _date_
+Build date:  |today|

diff --git a/utils/infra_setup/index.rst b/utils/infra_setup/index.rst
new file mode 100644 (file)
index 0000000..e8b7fc6
--- /dev/null
+++ b/utils/infra_setup/index.rst
@@ -0,0 +1,30 @@
+.. OPNFV Release Engineering documentation, created by
+   sphinx-quickstart on Tue Jun  9 19:12:31 2015.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+.. image:: ../etc/opnfv-logo.png
+  :height: 40
+  :width: 200
+  :alt: OPNFV
+  :align: left
+
+Documentation table of contents for infra_setup
+===============================================
+
+Contents:
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   README.rst
+
+Indices and tables
+==================
+
+* :ref:`search`
+
+Revision: _sha1_
+
+Build date: |today|

diff --git a/utils/monitor_setup/README.rst b/utils/monitor_setup/README.rst
index 87e7ee3..2eee5a8 100644 (file)
--- a/utils/monitor_setup/README.rst
+++ b/utils/monitor_setup/README.rst
@@ -1,4 +1,12 @@
-===================
+..
+.. image:: ../etc/opnfv-logo.png
+  :height: 40
+  :width: 200
+  :alt: OPNFV
+  :align: left
+..
+|
+|

 Monitor Setup guide
 ===================
 
 Monitor Setup guide
 ===================
 


@@ -9,7 +17,9 @@ Zabbix
 
 Zabbix is the ultimate enterprise-level software designed for real-time monitoring of millions of metrics collected from tens of thousands of servers, virtual machines and network devices. Zabbix is Open Source and comes at no cost.
 
 
 Zabbix is the ultimate enterprise-level software designed for real-time monitoring of millions of metrics collected from tens of thousands of servers, virtual machines and network devices. Zabbix is Open Source and comes at no cost.
 

-The link https://www.zabbix.com/documentation/2.2/manual/installation/install_from_packages gives the instalation guide of Zabbix in linux servers. After the installation of Zabbix server and agent, there is a need to configure the .conf files::
+The link https://www.zabbix.com/documentation/2.2/manual/installation/install_from_packages gives the instalation guide of Zabbix in linux servers. After the installation of Zabbix server and agent, there is a need to configure the .conf files
+
+.. code-block:: bash

 
    vim /etc/zabbix/zabbix_agentd.conf
 
 
    vim /etc/zabbix/zabbix_agentd.conf
 


@@ -18,3 +28,7 @@ The link https://www.zabbix.com/documentation/2.2/manual/installation/install_fr
        Hostname=<Agent_IP>
 
 To add the Zabbix agent host to be monitored, please click Configuration->Hosts->Create host on the Zabbix server dashboard.
        Hostname=<Agent_IP>
 
 To add the Zabbix agent host to be monitored, please click Configuration->Hosts->Create host on the Zabbix server dashboard.

+
+Revision: _sha1_
+
+Build date: |today|

diff --git a/utils/monitor_setup/index.rst b/utils/monitor_setup/index.rst
new file mode 100644 (file)
index 0000000..60ecaba
--- /dev/null
+++ b/utils/monitor_setup/index.rst
@@ -0,0 +1,30 @@
+.. OPNFV Release Engineering documentation, created by
+   sphinx-quickstart on Tue Jun  9 19:12:31 2015.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+.. image:: ../etc/opnfv-logo.png
+  :height: 40
+  :width: 200
+  :alt: OPNFV
+  :align: left
+
+Documentation table of contents for monitor_setup
+=================================================
+
+Contents:
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   README.rst
+
+Indices and tables
+==================
+
+* :ref:`search`
+
+Revision: _sha1_
+
+Build date: |today|