Doc updates according to DOCS project

Upddating QTIP docs according to DOCS project wiki in:
https://wiki.opnfv.org/display/DOC/Configurartion+guide and
https://wiki.opnfv.org/display/DOC/Userguide

JIRA: QTIP-102

Change-Id: Iab5bdcf3f290bc88d2fedc8a0153e26daf89cde8
Signed-off-by: Julien <zhang.jun3g@zte.com.cn>

15 files changed, 183 insertions, 204 deletions

diff --git a/docs/apidocs/.keep b/docs/apidocs/.keep
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/apidocs/.keep
diff --git a/docs/user_guides/02-installation.rst b/docs/configguide/configuration.rst
index 2f2ecf96..f29947d5 100644
--- a/docs/user_guides/02-installation.rst
+++ b/docs/configguide/configuration.rst
@@ -1,35 +1,28 @@
-Installation
-============
-
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywriters name>
-.. two dots create a comment. please leave this logo at the top of each of your rst files.
-.. image:: ../etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-.. these two pipes are to seperate the logo from the first title
+.. (c) 2015 Dell Inc.
+.. (c) 2016 ZTE Corp.
+
 
-|
+Qtip configuration
+==================
 
-QTIP currently supports by using a Docker image or by pulling the repo from the upstream
-repository found at https://git.opnfv.org/qtip. Detailed steps about setting up QTIP using both of these options
-can be found below.
+QTIP currently supports by using a Docker image or by pulling the repo from
+the upstream repository found at https://git.opnfv.org/qtip. Detailed steps
+about setting up QTIP using both of these options can be found below.
 
-To use QTIP you should have access to an OpenStack environment,
-with at least Nova, Neutron, Glance, Keystone and Heat installed.
+To use QTIP you should have access to an OpenStack environment, with at least
+Nova, Neutron, Glance, Keystone and Heat installed. Add a brief introduction
+to configure OPNFV with this specific installer
 
-The steps needed to run QTIP are:
 
-Running QTIP by pulling the upstream code
------------------------------------------
+Pre-configuration activities
+----------------------------
 
-.. _install-dependencies:
 
 Setting QTIP framework on Ubuntu 14.04
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 Install dependencies:
 ::
 
@@ -46,96 +39,116 @@ Download source code and install python dependencies:
   git clone https://git.opnfv.org/qtip
   cd qtip
 
+
 Installing QTIP using Docker
----------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-QTIP has a Docker images on the docker hub which can be pull after docker has been installed.
+QTIP has a Docker images on the docker hub. Pulling opnfv/qtip docker image
+from docker hub:
+::
 
-Installing Docker
-^^^^^^^^^^^^^^^^^
-The first step is to install docker:
+  sudo docker pull opnfv/qtip
+
+Verify that opnfv/qtip has been downloaded. It should be listed as an image by
+running the following command.
 ::
 
-  sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D
+  sudo docker images
+
+Run the Docker instance:
+::
 
+  docker run opnfv/qtip -i -t bash
 
-Add an entry for your Ubuntu operating system
+Now you are in the container and QTIP can be found in the  /repos/qtip and can
+be navigated to using the following command.
 ::
 
-  Open the /etc/apt/sources.list.d/docker.list file in your favorite editor.
+  cd repos/qtip
 
-If the file doesn’t exist, create it.
 
-Remove any existing entries.
+OpenStack parameters and credentials
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Add an entry for your Ubuntu operating system.
 
-On Ubuntu Trusty 14.04 (LTS)
+Environment variables
+"""""""""""""""""""""
+
+Before running QTIP it is necessary to export OpenStack environment variables
+from the OpenStack *openrc* file. This can be done by running the following
+command.
 ::
 
-  deb https://apt.dockerproject.org/repo ubuntu-trusty main
+  source get_env_info.sh -n {INSTALLER_TYPE} -i {INSTALLER_IP}
+  source opnfv-creds.sh
 
-Update the package manager
+This provides a ``opnfv-creds.sh`` file which can be sources to get the
+environment variables. For running QTIP manually, it is also necessary to
+export the installer type.
 ::
 
-  sudo apt-get update
+  export INSTALLER_TYPE="{installer-type}"
 
-Install Docker:
-::
 
-  sudo apt-get install docker-engine
+QTIP  default key pair
+""""""""""""""""""""""
 
-Starting Docker Daemon:
-::
+QTIP uses a SSH key pair to connect to the guest image. This key pair can
+be found in the ``data/`` directory.
 
-  sudo service docker start
 
-Pulling opnfv/qtip docker image from docker hub:
-::
+Hardware configuration
+----------------------
 
-  sudo docker pull opnfv/qtip
+Qtip does not have specific hardware requriements, and it can runs over any
+OPNFV installer.
 
-Verify that opnfv/qtip has been downloaded. It should be listed as an image by running the following command.
-::
 
-  sudo docker images
+Jumphost configuration
+----------------------
 
-Run the Docker instance:
+Installer Docker on Jumphost, which is used for running Qtip image.
+
+The first step is to install docker:
 ::
 
-  docker run opnfv/qtip -i -t bash
+  sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80
+  --recv-keys 58118E89F3A912897C070ADBF76221572C52609D
 
-Now you are in the container and QTIP can be found in the  /repos/qtip and can be navigated to using the following command.
 
+Add an entry for your Ubuntu operating system:
 ::
 
-  cd repos/qtip
+  Open the /etc/apt/sources.list.d/docker.list file in your favorite editor.
 
+If the file doesn’t exist, create it.
 
-OpenStack parameters and credentials
-------------------------------------
+Remove any existing entries.
 
+Add an entry for your Ubuntu operating system.
 
-Environment variables
-^^^^^^^^^^^^^^^^^^^^^
-Before running QTIP it is necessary to export OpenStack environment variables
-from the OpenStack *openrc* file. This can be done by running the following command.
+On Ubuntu Trusty 14.04 (LTS)
 ::
 
-  source get_env_info.sh -n {INSTALLER_TYPE} -i {INSTALLER_IP}
-  source opnfv-creds.sh
+  deb https://apt.dockerproject.org/repo ubuntu-trusty main
 
-This provides a ``opnfv-creds.sh`` file which can be sources to get the environment variables.
-For running QTIP manually, it is also necessary to export the installer type. ::
+Update the package manager
+::
 
-  export INSTALLER_TYPE="{installer-type}"
+  sudo apt-get update
 
-QTIP  default key pair
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-QTIP uses a SSH key pair to connect to the guest image. This key pair can
-be found in the ``data/`` directory.
+Install Docker:
+::
 
-Examples
---------
-QTIP Has been made with the intention of requiring minimal interaction from the user.
+  sudo apt-get install docker-engine
+
+Starting Docker Daemon:
+::
+
+  sudo service docker start
+
+
+Platform components configuration
+---------------------------------
 
+Describe the configuration of each component in the installer
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
new file mode 100644
index 00000000..e8b6f4e1
--- /dev/null
+++ b/docs/configguide/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015 Dell Inc.
+.. (c) 2016 ZTE Corp.
+
+****************
+QTIP Configguide
+****************
+
+.. toctree::
+   :maxdepth: 2
+
+   ./configuration.rst
diff --git a/docs/roadmap/index.rst b/docs/roadmap/index.rst
new file mode 100644
index 00000000..4e30d5ae
--- /dev/null
+++ b/docs/roadmap/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015 Dell Inc.
+.. (c) 2016 ZTE Corp.
+
+************
+Qtip Roadmap
+************
+
+.. toctree::
+   :maxdepth: 2
+
+   ./roadmap.rst
diff --git a/docs/roadmap.rst b/docs/roadmap/roadmap.rst
index 42caec92..42caec92 100644
--- a/docs/roadmap.rst
+++ b/docs/roadmap/roadmap.rst
diff --git a/docs/templates/index.rst b/docs/templates/index.rst
index c893df6f..1a8bc649 100644
--- a/docs/templates/index.rst
+++ b/docs/templates/index.rst
@@ -1,30 +1,13 @@
-.. 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.
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015 Dell Inc.
+.. (c) 2016 ZTE Corp.
 
-.. image:: ../etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-
-Example Documentation table of contents
-=======================================
-
-Contents:
+**************
+QTIP Templates
+**************
 
 .. toctree::
-   :numbered:
-   :maxdepth: 4
-
-   testcase_description_v2_template.rst
-
-Indices and tables
-==================
-
-* :ref:`search`
-
-Revision: _sha1_
+   :maxdepth: 2
 
-Build date: |today|
+   ./testcase_description_v2_template.rst
diff --git a/docs/sample_config.yaml b/docs/templates/sample_config.yaml
index 8dcaa11c..8dcaa11c 100644
--- a/docs/sample_config.yaml
+++ b/docs/templates/sample_config.yaml
diff --git a/docs/user_guides/01-introduction.rst b/docs/user_guides/01-introduction.rst
deleted file mode 100644
index 6322d092..00000000
--- a/docs/user_guides/01-introduction.rst
+++ /dev/null
@@ -1,40 +0,0 @@
-Introduction
-============
-
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywriters name>
-.. two dots create a comment. please leave this logo at the top of each of your rst files.
-.. image:: ../etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-.. these two pipes are to seperate the logo from the first title
-
-|
-
-**Welcome to QTIP's documentation !**
-
-.. _QTIP: https://wiki.opnfv.org/platform_performance_benchmarking
-
-QTIP_ is an OPNFV Project.
-
-QTIP aims to benchmark OPNFV platforms through a "Bottom up" approach, testing bare-metal components first.
-
-The overall problem this project tries to solve is the general characterization of an OPNFV platform.
-It will focus on general performance questions that are common to the platform itself, or applicable to multiple OPNFV use cases.
-QTIP will provide the capability to quantify a platform's performance behavior in a standardized, rigorous, and open way.
-
-The *QTIP* framework is deployed in the Dell OPNFV community lab. It is
-infrastructure and application independent.
-
-.. _Pharos: https://wiki.opnfv.org/pharos
-.. seealso:: Pharos_ for information on OPNFV community labs.
-
-**Contact QTIP**
-
-Feedback? `Contact us`_
-
-.. _Contact us: opnfv-users@lists.opnfv.org
-
diff --git a/docs/user_guides/index.rst b/docs/user_guides/index.rst
deleted file mode 100644
index da14761c..00000000
--- a/docs/user_guides/index.rst
+++ /dev/null
@@ -1,17 +0,0 @@
-================================
-QTIP Framework Documentation
-=================================
-
-.. toctree::
-   :numbered:
-   :maxdepth: 4
-
-   01-introduction.rst
-   02-installation.rst
-   03-usage-guide.rst
-   test_cases/01-compute_testcases.rst
-   test_cases/02-network_testcases.rst
-   test_cases/03-storage_testcases.rst
-
-Revision: _sha1_
-Build date: |today|
diff --git a/docs/user_guides/test_cases/01-compute_testcases.rst b/docs/userguide/01-compute.rst
index b3531298..6e6a7a04 100644
--- a/docs/user_guides/test_cases/01-compute_testcases.rst
+++ b/docs/userguide/01-compute.rst
@@ -1,19 +1,12 @@
-Compute test cases
-==================
-
 .. This wonk is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://cneativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywniters name>
-.. two dots cneate a comment. please leave this logo at the top of each of your rst files.
+.. (c) 2015 Dell Inc.
+.. (c) 2016 ZTE Corp.
 
-.. image:: ../../etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-.. these two pipes ane to seperate the logo from the first title
 
-|
+Compute test cases
+==================
+
 
 Introduction
 ------------
diff --git a/docs/user_guides/test_cases/02-network_testcases.rst b/docs/userguide/02-network.rst
index 45c2d824..bc475ad3 100644
--- a/docs/user_guides/test_cases/02-network_testcases.rst
+++ b/docs/userguide/02-network.rst
@@ -1,18 +1,11 @@
-Network test cases
-==================
-
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywriters name>
-.. two dots create a comment. please leave this logo at the top of each of your rst files.
-.. image:: ../../etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-.. these two pipes are to seperate the logo from the first title
-
-|
+.. (c) 2015 Dell Inc.
+.. (c) 2016 ZTE Corp.
+
+
+Network test cases
+==================
 
 QTIP uses IPerf3 as the main tool for testing the network throughput.
 There are three tests that are run through the QTIP framework.
diff --git a/docs/user_guides/test_cases/03-storage_testcases.rst b/docs/userguide/03-storage.rst
index cd557683..ea3bb4f3 100644
--- a/docs/user_guides/test_cases/03-storage_testcases.rst
+++ b/docs/userguide/03-storage.rst
@@ -1,18 +1,11 @@
-Storage test cases
-==================
-
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywriters name>
-.. two dots create a comment. please leave this logo at the top of each of your rst files.
-.. image:: ../../etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-.. these two pipes are to seperate the logo from the first title
+.. (c) 2015 Dell Inc.
+.. (c) 2016 ZTE Corp.
 
-|
+
+Storage test cases
+==================
 
 The QTIP benchmark suite aims to evaluate storage components within an OPNFV platform.
 For Brahamaputra release, FIO would evaluate File System performance for the host machine.
@@ -36,4 +29,3 @@ The FIO Job would consist of:
 6. Block size :4K
 
 For this Job, I/O per second would be measured along mean I/O latency to provide storage performance numbers.
-
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
new file mode 100644
index 00000000..fe24293a
--- /dev/null
+++ b/docs/userguide/index.rst
@@ -0,0 +1,21 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015 Dell Inc.
+.. (c) 2016 ZTE Corp.
+
+
+**************
+QTIP Userguide
+**************
+
+Colorado 1.0
+------------
+
+.. toctree::
+   :maxdepth: 2
+
+   ./overview.rst
+   ./introduction.rst
+   ./01-compute_testcases.rst
+   ./02-network_testcases.rst
+   ./03-storage_testcases.rst
diff --git a/docs/user_guides/03-usage-guide.rst b/docs/userguide/introduction.rst
index 56cc16b3..d3bba51d 100644
--- a/docs/user_guides/03-usage-guide.rst
+++ b/docs/userguide/introduction.rst
@@ -1,18 +1,12 @@
-Guide to run QTIP:
-==================
-
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywriters name>
-.. two dots create a comment. please leave this logo at the top of each of your rst files.
-.. image:: ../etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-.. these two pipes are to seperate the logo from the first title
+.. (c) 2015 Dell Inc.
+.. (c) 2016 ZTE Corp.
+
 
-|
+*****************
+Qtip Introduction
+*****************
 
 This guide will serve as a first step to familiarize the user with how to
 run QTIP the first time when the user clones QTIP on to their host machine.
@@ -341,4 +335,3 @@ Running QTIP on the using `default` as the pod name and for the `storage` suite
 Results:
 --------
 QTIP generates results in the `results/` directory are listed down under the particularly benchmark name. So all the results for dhrystone would be listed and time stamped.
-
diff --git a/docs/userguide/overview.rst b/docs/userguide/overview.rst
new file mode 100644
index 00000000..82b7de91
--- /dev/null
+++ b/docs/userguide/overview.rst
@@ -0,0 +1,22 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015 Dell Inc.
+.. (c) 2016 ZTE Corp.
+
+
+********
+Overview
+********
+
+.. _QTIP: https://wiki.opnfv.org/platform_performance_benchmarking
+
+QTIP_ is an OPNFV Project.
+
+QTIP aims to benchmark OPNFV platforms through a "Bottom up" approach, testing
+bare-metal components first.
+
+The overall problem this project tries to solve is the general
+characterization of an OPNFV platform. It will focus on general performance
+questions that are common to the platform itself, or applicable to multiple
+OPNFV use cases. QTIP will provide the capability to quantify a platform's
+performance behavior in a standardized, rigorous, and open way.