Docs: Review and update the docs for E-release

JIRA: SAMPLEVNF-82

Review and update the the E-release docsuments.

Change-Id: I1eeb0dead18559b8f05039b81512d944a862bbb4
Signed-off-by: Anand B Jyoti <anand.b.jyoti@intel.com>

3 files changed, 21 insertions, 16 deletions

diff --git a/docs/testing/developer/design/01-Overview.rst b/docs/testing/developer/design/01-Overview.rst
index e4c7a984..a1ae66af 100644
--- a/docs/testing/developer/design/01-Overview.rst
+++ b/docs/testing/developer/design/01-Overview.rst
@@ -26,7 +26,7 @@ real life use-case based testing and NFVi characterization for the same.
 The sample VNFs are Open Source approximations* of Telco grade VNF’s using optimized
 VNF + NFVi Infrastructure libraries, with Performance Characterization of Sample† Traffic Flows.
   * * Not a commercial product. Encourage the community to contribute and close the feature gaps.
-  * † No Vendor/Proprietary Workloads 
+  * † No Vendor/Proprietary Workloads
 
 It helps to facilitate deterministic & repeatable bench-marking on
 Industry standard high volume Servers. It augments well with a Test Infrastructure
@@ -46,6 +46,6 @@ Integrate into CI tool chain and existing test frameworks for VNF feature and de
 Testability:
 -----------
 Network Service Testing framework added into the Yardstick will be used as a test
-tool for Functional/Performance verification of all the sample VNFs. 
+tool for Functional/Performance verification of all the sample VNFs.
 Planning to extend the same to FuncTest and Models project to include the testcases
 related to sample VNFs.
diff --git a/docs/testing/developer/design/02-Get_started_Guide.rst b/docs/testing/developer/design/02-Get_started_Guide.rst
index 4bcff899..995a2270 100644
--- a/docs/testing/developer/design/02-Get_started_Guide.rst
+++ b/docs/testing/developer/design/02-Get_started_Guide.rst
@@ -59,11 +59,11 @@ In this way, individual commits can be traced to JIRA issues and we also know wh
 commits were used to resolve a JIRA issue.
 If you want to contribute to samplevnf, you can pick a issue from SampleVNF's
 JIRA dashboard or you can create you own issue and submit it to JIRA.
- 
+
 Submitting code to Gerrit
 Installing and configuring Git and Git-Review is necessary in order to submit code to Gerrit.
 The Getting to the code page will provide you with some help for that.
- 
+
 Comitting the code with Git
 Open a terminal window and set the project's directory to the working directory using the cd command.
 In this case "/home/opnfv/samplevnf" is the path to the samplevnf project folder on my computer.
@@ -97,11 +97,11 @@ it is time to actually commit your work to your local Git repository.
 
 ::
   git commit --signoff -m "Title of change
-     
+
   Test of change that describes in high level what
   was done. There is a lot of documentation in code
   so you do not need to repeat it here.
-     
+
   JIRA: SAMPLEVNF-XXX"
 
 The message that is required for the commit should follow a specific set of rules.
@@ -122,7 +122,7 @@ This will automatically push your local commit into Gerrit.
 
 Code review
 You can add Samplevnf committers and contributors to review your codes.
- 
+
 Modifying the code under review in Gerrit
 At the same time the code is being reviewed in Gerrit, you may need to edit it to
 make some changes and then send it back for review. The following steps go through the procedure.
@@ -132,7 +132,7 @@ The 'status' command is very helpful at this point as it provides an overview of
 ::
   git status
 The output of the command provides us with the files that have been modified after the latest commit.
- 
+
 You can now stage the files that have been modified as part of the Gerrit code review
 edition/modification/improvement using git add command.
 It is now time to commit the newly modified files, but the objective here is not to
@@ -144,7 +144,7 @@ You can achieve that with the '--amend' option on the 'commit' command:
 
 If the commit was successful, the 'status' command should not return the updated
 files as about to be commited.
- 
+
 The final step consists in pushing the newly modified commit to Gerrit.
 
 ::
diff --git a/docs/testing/developer/requirements/03-Requirements.rst b/docs/testing/developer/requirements/03-Requirements.rst
index ce43e06a..dab07a6e 100644
--- a/docs/testing/developer/requirements/03-Requirements.rst
+++ b/docs/testing/developer/requirements/03-Requirements.rst
@@ -25,7 +25,7 @@ Connected to the DUT is an IXIA* or Software Traffic generator like pktgen or TR
 simulation platform to generate packet traffic to the DUT ports and
 determine the throughput/latency at the tester side.
 
-Below are the supported/tested (:term `VNF`) deployment type.
+Below are the supported/tested (:term:`VNF`) deployment type.
 .. image:: images/deploy_type.png
    :width: 800px
    :alt: SampleVNF supported topology
@@ -67,22 +67,27 @@ Hardware & Software Ingredients
 
 Network Topology for testing VNFs
 ---------------------------------
+
 The ethernet cables should be connected between traffic generator and the VNF server (BM,
 SRIOV or OVS) setup based on the test profile.
 
 The connectivity could be
-1. Single port pair : One pair ports used for traffic 
-   ::
+
+- Single port pair : One pair ports used for traffic
+
+::
      e.g. Single port pair link0 and link1 of VNF are used
      TG:port 0 <------> VNF:Port 0
      TG:port 1 <------> VNF:Port 1
 
-2. Multi port pair :  More than one pair of traffic
-   ::
+-  Multi port pair :  More than one pair of traffic
+
+::
+
      e.g. Two port pair link 0, link1, link2 and link3 of VNF are used
      TG:port 0 <------> VNF:Port 0
      TG:port 1 <------> VNF:Port 1
-     TG:port 2 <------> VNF:Port 2 
+     TG:port 2 <------> VNF:Port 2
      TG:port 3 <------> VNF:Port 3
-For openstack/Standalone virtualization, installation please refer the openstack guide and ovs-dpdk/sriov github. 
+For openstack/Standalone virtualization, installation please refer the openstack guide and ovs-dpdk/sriov github.
 (TBA - Add link to guide)