From 5e1a84abafbbb222e2e032af4891a567a86d6687 Mon Sep 17 00:00:00 2001
From: Yujun Zhang <zhang.yujunz@zte.com.cn>
Date: Sun, 28 May 2017 11:19:39 +0800
Subject: Update getting started guide

Change-Id: Ic40c9f30dc2d803e047a5f39aa0b20de24b6a60b
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
---
 docs/testing/user/userguide/getting-started.rst | 60 ++++++++++++++++---------
 docs/testing/user/userguide/index.rst           |  2 +-
 2 files changed, 41 insertions(+), 21 deletions(-)

(limited to 'docs')

diff --git a/docs/testing/user/userguide/getting-started.rst b/docs/testing/user/userguide/getting-started.rst
index 8289a9c2..0f60f13f 100644
--- a/docs/testing/user/userguide/getting-started.rst
+++ b/docs/testing/user/userguide/getting-started.rst
@@ -5,10 +5,29 @@
 Getting started with QTIP
 *************************
 
-Overview
-========
+.. code-block::
+
+    pip install qtip
+    eval $(ssh-agent)
+
+    qtip create <project_name>
+    cd <project_name>
+
+    qtip setup
+    qtip run
+    qtip teardown
+
+Installation
+============
+
+Refer to `installation and configuration guide`_ for details
+
+.. _installation and configuration guide:../configguide/
 
-Create a new project to hold the neccessary configurations and test results
+Create
+======
+
+Create a new project to hold the necessary configurations and test results
 ::
 
     qtip create <project_name>
@@ -29,32 +48,33 @@ The user would be prompted for OPNFV installer, its hostname etc
     **OPNFV Scenario [unknown]: os-nosdn-nofeature-ha**
     Depends on the OPNFV scenario deployed
 
-With the framework generated, user should now proceed on to setting up testing environment. In this step, information related to OPNFV cluster would
-be generated, such as getting the IP addresses of the nodes in System Under Test (SUT).
-::
+Setup
+=====
+
+With the project is created, user should now proceed on to setting up testing environment. In this step, ssh connection
+to hosts in SUT will be configured automatically::
 
     cd <project_name>
     $ qtip setup
 
-QTIP uses `ssh-agent` for authentication. It is critical that it started and stopped in the correct way.
-
+Run
+===
 
-ssh-agent
-=========
+QTIP uses ``ssh-agent`` for authentication of ssh connection to hosts in SUT. It must be started correctly before
+running the tests::
 
-ssh-agent is used to hold the private keys for RSA, DCA authentication. In order to start the process
-::
+    eval $(ssh-agent)
 
-    $ eval $(ssh-agent)
+Then run test with ``qtip run``
 
-This would start the agent in background. One must now be able to execute QTIP
-::
+Teardown
+========
 
-    $ qtip run
+Clean up the temporary folder on target hosts.
 
-However, if QTIP is not working because of `ssh-agent`, one should kill the process as follows
-::
+.. note:: The installed packages for testing won't be uninstalled.
 
-    $ eval $(ssh-agent -k)
+One more thing
+==============
 
-Then start the agent again as described above.
+You may use ``-v`` for verbose output (``-vvv`` for more, ``-vvvv`` to enable connection debugging)
diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst
index 9b6ab888..e6eaea59 100644
--- a/docs/testing/user/userguide/index.rst
+++ b/docs/testing/user/userguide/index.rst
@@ -12,7 +12,7 @@ QTIP User Guide
    :maxdepth: 2
 
    overview.rst
+   getting-started.rst
    cli.rst
    api.rst
    compute.rst
-   getting-started.rst
-- 
cgit 1.2.3-korg