Adapt documentation to latest guidelines

Adapt Yardstick documentation according to the latest guidelines from the
Releng project.

The only change in test case description TC001 and TC002 is to remove logo.
The same for the test case description v2 template.

The previous version of test case description is deleted from repo.

The Yardstick_task_template is edited to keep line lenght 80 char.

This commit also adds index for docs/yardstick and for
docs/user_guides/framework.

The overview for the vTC .rst file has been fixed to enable the .pdf
generation.

Change-Id: Ib6480c3c29ce0f0ee22c9ad717439f6a293ab842
Signed-off-by: Ana C <ana.cunha@ericsson.com>

1 files changed, 31 insertions, 40 deletions

diff --git a/docs/vTC/README.rst b/docs/vTC/README.rst
index 018573541..ae6fefa59 100644
--- a/docs/vTC/README.rst
+++ b/docs/vTC/README.rst
@@ -1,20 +1,24 @@
-=========
-Yardstick
-=========
+==========================
+Virtual Traffic Classifier
+==========================
 
-Overview of the virtual Traffic Classifier
+Overview
 ========
+
 The virtual Traffic Classifier VNF [1], comprises in the current version of
 1 VNFC [2]. The VNFC contains both the Traffic Inspection module, and the
 Traffic forwarding module, needed to run the VNF. The exploitation of DPI
 methods for traffic classification is built around two basic assumptions:
+
 (i) third parties unaffiliated with either source or recipient are able to
 inspect each IP packet’s payload and
 (ii) the classifier knows the relevant syntax of each application’s packet
 payloads (protocol signatures, data patterns, etc.).
-The proposed DPI based approach will only use an indicative, small number of the
-initial packets from each flow in order to identify the content and not inspect
-each packet.
+
+The proposed DPI based approach will only use an indicative, small number of
+the initial packets from each flow in order to identify the content and not
+inspect each packet.
+
 In this respect it follows the Packet Based per Flow State (PBFS).
 This method uses a table to track each session based on the 5-tuples
 (src address,dest address,src port,dest port,transport protocol)
@@ -22,6 +26,7 @@ that is maintained for each flow.
 
 Concepts
 ========
+
 Traffic Inspection: The process of packet analysis and application
 identification of network traffic that passes through the vTC.
 
@@ -29,7 +34,8 @@ Traffic Forwarding: The process of packet forwarding from an incoming
 network interface to a pre-defined outgoing network interface.
 
 Traffic Rule Application: The process of packet tagging, based on a
-predefined set of rules. Packet tagging may include e.g. ToS field modification.
+predefined set of rules. Packet tagging may include e.g. ToS field
+modification.
 
 Architecture
 ============
@@ -37,44 +43,29 @@ Architecture
 The Traffic Inspection module is the most computationally intensive component
 of the VNF. It implements filtering and packet matching algorithms in order to
 support the enhanced traffic forwarding capability of the VNF. The component
-supports a flow table (exploiting hashing algorithms for fast indexing of flows)
-and an inspection engine for traffic classification. The implementation used for
-these experiments exploits the nDPI library. The packet capturing mechanism is
-implemented using libpcap. When the DPI engine identifies a new flow, the flow
-register is updated with the appropriate information and transmitted across the
-Traffic Forwarding module, which then applies any required policy updates.
+supports a flow table (exploiting hashing algorithms for fast indexing of
+flows) and an inspection engine for traffic classification.
+
+The implementation used for these experiments exploits the nDPI library.
+The packet capturing mechanism is implemented using libpcap. When the DPI
+engine identifies a new flow, the flow register is updated with the
+appropriate information and transmitted across the Traffic Forwarding module,
+which then applies any required policy updates.
+
 The Traffic Forwarding moudle is responsible for routing and packet forwarding.
 It accepts incoming network traffic, consults the flow table for classification
-information for each incoming flow and then applies pre-defined policies marking
-e.g. type of Service/Differentiated Services Code Point (TOS/DSCP) multimedia
-traffic for QoS enablement on the forwarded traffic. It is assumed that the
-traffic is forwarded using the default policy until it is identified and new
-policies are enforced. The expected response delay is considered to be
-negligible,as only a small number of packets are required to identify each flow.
+information for each incoming flow and then applies pre-defined policies
+marking e.g. type of Service/Differentiated Services Code Point (TOS/DSCP)
+multimedia traffic for QoS enablement on the forwarded traffic.
+It is assumed that the traffic is forwarded using the default policy until it
+is identified and new policies are enforced.
+
+The expected response delay is considered to be negligible,as only a small
+number of packets are required to identify each flow.
 
 Graphical Overview
 ==================
 
-+----------------------------+
-|                            |
-| Virtual Traffic Classifier |
-|                            |
-|     Analysing/Forwarding   |
-|         +-------->         |
-|     ethA          ethB     |
-+------+--------------+------+
-       |              ^
-       |              |
-       |              |
-       |              |
-       v              |
-+------+--------------+------+
-|                            |
-|     Virtual Switch         |
-|                            |
-+----------------------------+
-
-
 Install
 =======