[docs] Documentation for BNG PPPoE RFC2544 test cases
[yardstick.git] / docs / testing / user / userguide / 01-introduction.rst
index 63d0d98..5fc2e8d 100755 (executable)
@@ -9,8 +9,8 @@ Introduction
 
 **Welcome to Yardstick's documentation !**
 
-.. _Pharos: https://wiki.opnfv.org/pharos
-.. _Yardstick: https://wiki.opnfv.org/yardstick
+.. _Pharos: https://wiki.opnfv.org/display/pharos
+.. _Yardstick: https://wiki.opnfv.org/display/yardstick
 .. _Presentation: https://wiki.opnfv.org/download/attachments/2925202/opnfv_summit_-_yardstick_project.pdf?version=1&modificationDate=1458848320000&api=v2
 
 Yardstick_ is an OPNFV Project.
@@ -21,8 +21,6 @@ of a Virtual Network Function (:term:`VNF`).
 The Project's scope is the development of a test framework, *Yardstick*, test
 cases and test stimuli to enable Network Function Virtualization Infrastructure
 (:term:`NFVI`) verification.
-The Project also includes a sample :term:`VNF`, the Virtual Traffic Classifier
-(:term:`VTC`)  and its experimental framework, *ApexLake* !
 
 *Yardstick* is used in OPNFV for verifying the OPNFV infrastructure and some of
 the OPNFV features. The *Yardstick* framework is deployed in several OPNFV
@@ -44,49 +42,45 @@ This document consists of the following chapters:
 * Chapter :doc:`02-methodology` describes the methodology implemented by the
   *Yardstick* Project for :term:`NFVI` verification.
 
-* Chapter :doc:`03-architecture` provides information on the software architecture
-  of *Yardstick*.
+* Chapter :doc:`03-architecture` provides information on the software
+  architecture of *Yardstick*.
 
 * Chapter :doc:`04-installation` provides instructions to install *Yardstick*.
 
-* Chapter :doc:`05-yardstick_plugin` provides information on how to integrate
+* Chapter :doc:`05-operation` provides information on how to use *Yardstick*
+  to run and create testcases.
+
+* Chapter :doc:`06-yardstick-plugin` provides information on how to integrate
   other OPNFV testing projects into *Yardstick*.
 
-* Chapter :doc:`06-result-store-InfluxDB` provides inforamtion on how to run
+* Chapter :doc:`07-result-store-InfluxDB` provides inforamtion on how to run
   plug-in test cases and store test results into community's InfluxDB.
 
-* Chapter :doc:`07-grafana` provides inforamtion on *Yardstick* grafana dashboard
-  and how to add a dashboard into *Yardstick* grafana dashboard.
+* Chapter :doc:`08-grafana` provides inforamtion on *Yardstick* grafana
+  dashboard and how to add a dashboard into *Yardstick* grafana dashboard.
 
-* Chapter :doc:`08-api` provides inforamtion on *Yardstick* ReST API and how to
+* Chapter :doc:`09-api` provides inforamtion on *Yardstick* ReST API and how to
   use *Yardstick* API.
 
-* Chapter :doc:`09-yardstick_user_interface` provides inforamtion on how to use
+* Chapter :doc:`10-yardstick-user-interface` provides inforamtion on how to use
   yardstick report CLI to view the test result in table format and also values
   pinned on to a graph
 
-* Chapter :doc:`10-vtc-overview` provides information on the :term:`VTC`.
-
-* Chapter :doc:`11-apexlake_installation` provides instructions to install the
-  experimental framework *ApexLake*
-
-* Chapter :doc:`12-apexlake_api` explains how this framework is integrated in
-  *Yardstick*.
-
-* Chapter :doc:`13-nsb-overview` describes the methodology implemented by the
+* Chapter :doc:`12-nsb-overview` describes the methodology implemented by the
   Yardstick - Network service benchmarking to test real world usecase for a
   given VNF.
 
-* Chapter :doc:`14-nsb_installation` provides instructions to install
-  *Yardstick - Network service benchmarking testing*.
+* Chapter :doc:`13-nsb-installation` provides instructions to install
+  *Yardstick - Network Service Benchmarking (NSB) testing*.
+
+* Chapter :doc:`14-nsb-operation` provides information on running *NSB*
 
 * Chapter :doc:`15-list-of-tcs` includes a list of available *Yardstick* test
   cases.
 
-
 Contact Yardstick
 =================
 
 Feedback? `Contact us`_
 
-.. _Contact us: opnfv-users@lists.opnfv.org
+.. _Contact us: mailto:opnfv-users@lists.opnfv.org&subject="#yardstick"