aboutsummaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide/02-methodology.rst
diff options
context:
space:
mode:
authorEmma Foley <emma.l.foley@intel.com>2018-08-28 14:16:54 +0100
committerEmma Foley <emma.l.foley@intel.com>2019-01-16 15:37:18 +0000
commit9c10763fedf5103bbd229648b17ee4a36d70e89e (patch)
tree82472e534877a06adec52f788432a4f1ae0a269f /docs/testing/user/userguide/02-methodology.rst
parent07c506d3fff732019651d89de14bf42fa8d9a365 (diff)
[docs] Make heading levels consistent
Update the symbols used to denote different headings to make them consistent across the userguide. JIRA: YARDSTICK-1335 Change-Id: Ib5ab1f14bbaa819cf882dc00d68bc27da3f1eadb Signed-off-by: Emma Foley <emma.l.foley@intel.com>
Diffstat (limited to 'docs/testing/user/userguide/02-methodology.rst')
-rw-r--r--docs/testing/user/userguide/02-methodology.rst22
1 files changed, 16 insertions, 6 deletions
diff --git a/docs/testing/user/userguide/02-methodology.rst b/docs/testing/user/userguide/02-methodology.rst
index 34d271095..b1eee9781 100644
--- a/docs/testing/user/userguide/02-methodology.rst
+++ b/docs/testing/user/userguide/02-methodology.rst
@@ -1,20 +1,30 @@
.. 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.
===========
Methodology
===========
Abstract
-========
+--------
This chapter describes the methodology implemented by the Yardstick project for
verifying the :term:`NFVI` from the perspective of a :term:`VNF`.
ETSI-NFV
-========
+--------
.. _NFV-TST001: http://www.etsi.org/deliver/etsi_gs/NFV-TST/001_099/001/01.01.01_60/gs_NFV-TST001v010101p.pdf
.. _Yardsticktst: https://wiki.opnfv.org/download/attachments/2925202/opnfv_summit_-_bridging_opnfv_and_etsi.pdf?version=1&modificationDate=1458848320000&api=v2
@@ -53,7 +63,7 @@ The methodology includes five steps:
.. seealso:: Yardsticktst_ for material on alignment ETSI TST001 and Yardstick.
Metrics
-=======
+-------
The metrics, as defined by ETSI GS NFV-TST001, are shown in
:ref:`Table1 <table2_1>`, :ref:`Table2 <table2_2>` and