docs: add LTP to index.rst

Fix build issues and add the LTP to index.rst.

JIRA: DOCS-95
Change-Id: I2d22646af935c544645c01600b92a5f51ede39ec
Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>

diff --git a/docs/requirements/index.rst b/docs/requirements/index.rst
index 22165be..311ddb0 100644 (file)
--- a/docs/requirements/index.rst
+++ b/docs/requirements/index.rst
@@ -2,13 +2,10 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) OPNFV, Intel Corporation, AT&T and others.
 
-******************************
-VSPERF LEVEL TEST DESIGN (LTD)
-******************************
-
 .. toctree::
    :maxdepth: 3
    :numbered: 5
 
+   vswitchperf_ltp.rst
    vswitchperf_ltd.rst
 

diff --git a/docs/requirements/vswitchperf_ltd.rst b/docs/requirements/vswitchperf_ltd.rst
index 5464c38..23dcd3c 100644 (file)
--- a/docs/requirements/vswitchperf_ltd.rst
+++ b/docs/requirements/vswitchperf_ltd.rst
@@ -2,21 +2,20 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) OPNFV, Intel Corporation, AT&T and others.
 
+******************************
+VSPERF LEVEL TEST DESIGN (LTD)
+******************************
+
 .. 3.1
 
-===============
 Introduction
 ===============
 
-The objective of the OPNFV project titled
-**“Characterize vSwitch Performance for Telco NFV Use Cases”**, is to
-evaluate a virtual switch to identify its suitability for a Telco
-Network Function Virtualization (NFV) environment. The intention of this
-Level Test Design (LTD) document is to specify the set of tests to carry
-out in order to objectively measure the current characteristics of a
-virtual switch in the Network Function Virtualization Infrastructure
-(NFVI) as well as the test pass criteria. The detailed test cases will
-be defined in details-of-LTD_, preceded by the doc-id_ and the scope_.
+The intention of this Level Test Design (LTD) document is to specify the set of
+tests to carry out in order to objectively measure the current characteristics
+of a virtual switch in the Network Function Virtualization Infrastructure
+(NFVI) as well as the test pass criteria. The detailed test cases will be
+defined in details-of-LTD_, preceded by the doc-id_ and the scope_.
 
 This document is currently in draft form.
 
@@ -86,11 +85,8 @@ References
 Details of the Level Test Design
 ===================================
 
-This section describes the features to be tested (
-FeaturesToBeTested_), the test approach (Approach_);
-it also identifies the sets of test cases or scenarios (
-TestIdentification_) along with the pass/fail criteria and
-the test deliverables.
+This section describes the features to be tested (FeaturesToBeTested_), and
+identifies the sets of test cases or scenarios (TestIdentification_).
 
 .. 3.2.1
 

diff --git a/docs/requirements/vswitchperf_ltp.rst b/docs/requirements/vswitchperf_ltp.rst
index 1487f72..e4e3126 100644 (file)
--- a/docs/requirements/vswitchperf_ltp.rst
+++ b/docs/requirements/vswitchperf_ltp.rst
@@ -4,6 +4,10 @@
 
 .. 3.1
 
+*****************************
+VSPERF LEVEL TEST PLAN (LTP)
+*****************************
+
 ===============
 Introduction
 ===============
@@ -27,12 +31,10 @@ This document is currently in draft form.
 Document identifier
 =========================
 
-The document id will be used to uniquely
-identify versions of the LTD. The format for the document id will be:
-OPNFV\_vswitchperf\_LTP\_REL\_STATUS, where by the
-status is one of: draft, reviewed, corrected or final. The document id
-for this version of the LTD is:
-OPNFV\_vswitchperf\_LTP\_Colorado\_REVIEWED.
+The document id will be used to uniquely identify versions of the LTP. The
+format for the document id will be: OPNFV\_vswitchperf\_LTP\_REL\_STATUS, where
+by the status is one of: draft, reviewed, corrected or final. The document id
+for this version of the LTP is: OPNFV\_vswitchperf\_LTP\_Colorado\_REVIEWED.
 
 .. 3.1.2
 
@@ -181,23 +183,24 @@ traceability. The matrix was expanded to 3x4 to accommodate scale metrics when
 displaying the coverage of many metrics/benchmarks). Test case covreage in the
 LTD is tracked using the following catagories:
 
-|------------------------------------------------------------------------|
+
++---------------+-------------+------------+---------------+-------------+
 |               |             |            |               |             |
 |               |   SPEED     |  ACCURACY  |  RELIABILITY  |    SCALE    |
 |               |             |            |               |             |
-|------------------------------------------------------------------------|
++---------------+-------------+------------+---------------+-------------+
 |               |             |            |               |             |
 |  Activation   |      X      |     X      |       X       |      X      |
 |               |             |            |               |             |
-|------------------------------------------------------------------------|
++---------------+-------------+------------+---------------+-------------+
 |               |             |            |               |             |
 |  Operation    |      X      |      X     |       X       |      X      |
 |               |             |            |               |             |
-|------------------------------------------------------------------------|
++---------------+-------------+------------+---------------+-------------+
 |               |             |            |               |             |
 | De-activation |             |            |               |             |
 |               |             |            |               |             |
-|------------------------------------------------------------------------|
++---------------+-------------+------------+---------------+-------------+
 
 X = denotes a test catagory that has 1 or more test cases defined.