add yardstick iruya 9.0.0 release notes

[yardstick.git] / docs / testing / user / userguide / 01-introduction.rst

diff --git a/docs/testing/user/userguide/01-introduction.rst b/docs/testing/user/userguide/01-introduction.rst
index d846e75..2a3ab4e 100755 (executable)
--- a/docs/testing/user/userguide/01-introduction.rst
+++ b/docs/testing/user/userguide/01-introduction.rst
@@ -1,7 +1,17 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International
-.. License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV, Ericsson AB and others.
+   License.
+   http://creativecommons.org/licenses/by/4.0
+   (c) OPNFV, Ericsson AB and others.
+
+   Convention for heading levels in Yardstick documentation:
+
+      =======  Heading 0 (reserved for the title in a document)
+      -------  Heading 1
+      ^^^^^^^  Heading 2
+      +++++++  Heading 3
+      '''''''  Heading 4
+
+      Avoid deeper levels because they do not render well.
 
 ============
 Introduction
@@ -9,8 +19,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.
@@ -32,7 +42,7 @@ independent.
 
 
 About This Document
-===================
+-------------------
 
 This document consists of the following chapters:
 
@@ -66,13 +76,11 @@ This document consists of the following chapters:
   yardstick report CLI to view the test result in table format and also values
   pinned on to a graph
 
-* Chapter :doc:`11-vtc-overview` provides information on the :term:`VTC`.
-
 * 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:`13-nsb_installation` provides instructions to install
+* 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*
@@ -81,8 +89,8 @@ This document consists of the following chapters:
   cases.
 
 Contact Yardstick
-=================
+-----------------
 
 Feedback? `Contact us`_
 
-.. _Contact us: mailto:opnfv-users@lists.opnfv.org&subject="[yardstick]"
+.. _Contact us: mailto:opnfv-users@lists.opnfv.org&subject="#yardstick"