From: ChristopherPrice <christopher.price@ericsson.com>
Date: Mon, 19 Sep 2016 09:28:51 +0000 (+0200)
Subject: Fixing the index.rst file to ensure it generates according to Colorado structure.
X-Git-Tag: colorado.1.0~6
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F39%2F21439%2F1;p=joid.git

Fixing the index.rst file to ensure it generates according to Colorado structure.

Requires immediate attention.

Change-Id: I09244271115bf5bea21ed2a4caaaa23f94f71e4c
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
(cherry picked from commit 82949c6e55dba77032c48d757d64cc259bfaa07a)
---

diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst
index 807b9bf4..6716e5c1 100644
--- a/docs/installationprocedure/index.rst
+++ b/docs/installationprocedure/index.rst
@@ -2,17 +2,13 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) <optionally add copywriters name>
 
-========================
-JOID Configuration guide
-========================
+=============================
+JOID installation instruction
+=============================
 
 .. toctree::
    :numbered:
    :maxdepth: 2
 
-
-.. add your content files here.
-
-.. include::  ./installationprocedure.rst
-
+  ./installationprocedure.rst
 
diff --git a/docs/installationprocedure/installationprocedure.rst b/docs/installationprocedure/installationprocedure.rst
index 511048d7..b561ffb3 100644
--- a/docs/installationprocedure/installationprocedure.rst
+++ b/docs/installationprocedure/installationprocedure.rst
@@ -1,15 +1,13 @@
-=================
-JOID Installation
-=================
-
-
 
 Bare Metal Installations:
-^^^^^^^^^^^^^^^^^^^^^^^^^
+=========================
+
 Requirements as per Pharos:
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+===========================
+
 Networking:
-^^^^^^^^^^^
+===========
+
 **Minimum 2 networks**
 
 | ``1. First for Admin network with gateway to access external network``
@@ -42,8 +40,9 @@ the Openstack please consider higher spec for each nodes.**
 
 Make sure all servers are connected to top of rack switch and configured accordingly. No DHCP server should be up and configured. Only gateway at eth0 and eth1 network should be configure to access the network outside your lab.
 
+------------------------
 Jump node configuration:
-~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------
 
 1. Install Ubuntu 14.04 LTS server version of OS on the nodes.
 2. Install the git and bridge-utils packages on the server and configure minimum two bridges on jump host:
@@ -76,7 +75,7 @@ use the appropriate network on jump-host depend upon VLAN ID on the interface.**
 
 
 Configure JOID for your lab
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+===========================
 
 **Get the joid code from gerritt**
 
@@ -106,10 +105,11 @@ If enabling first time then follow it further.
 labconfig.yaml
 
 labconfig.yaml file
-^^^^^^^^^^^^^^^^^^^^
+===================
 
+-------------
 Prerequisite:
-~~~~~~~~~~~~~
+-------------
 
 1. Make sure Jump host node has been configured with bridges on each interface,
 so that appropriate MAAS and JUJU bootstrap VM can be created. For example if
@@ -117,8 +117,9 @@ you have three network admin, data and public then I would suggest to give names
 like brAdm, brData and brPublic.
 2. You have information about the node MAC address and power management details (IPMI IP, username, password) of the nodes used for control and compute node.
 
+---------------------
 modify labconfig.yaml
-^^^^^^^^^^^^^^^^^^^^^^
+---------------------
 
 This file has been used to configure your maas and bootstrap node in a
 VM. Comments in the file are self explanatory and we expect fill up the
@@ -227,12 +228,13 @@ NOTE: If you are using VLAN tagged network then make sure you modify the case $1
     ;;*
 
 Deployment of OPNFV using JOID:
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+===============================
 
 Once you have done the change in above section then run the following commands to do the automatic deployments.
 
+------------
 MAAS Install
-~~~~~~~~~~~~
+------------
 
 After integrating the changes as mentioned above run the MAAS install.
 Suppose you name the integration lab as intelpod7 then run the below
@@ -240,6 +242,7 @@ commands to start the MAAS deployment.
 
 ``   ./00-maasdeploy.sh custom ../labconfig/intel/pod7/labconfig.yaml``
 
+-------------
 OPNFV Install
 -------------
 
@@ -274,8 +277,9 @@ NOTE: Possible options are as follows:
   ipv6: ipv6 will be enabled for tenant in openstack.*
 
 
+------------
 Troubleshoot
-~~~~~~~~~~~~
+------------
 
 By default debug is enabled in script and error messages will be printed on ssh terminal where you are running the scripts.