aboutsummaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide/01-introduction.rst
diff options
context:
space:
mode:
authorVolodymyr Mytnyk <volodymyrx.mytnyk@intel.com>2019-01-17 09:54:40 +0000
committerGerrit Code Review <gerrit@opnfv.org>2019-01-17 09:54:40 +0000
commita1b5c651cf66eaf98024e7e9c09632ebfdc53fb6 (patch)
tree5ac4b13ad597878adb12f03c91ae9c91f2f3012c /docs/testing/user/userguide/01-introduction.rst
parenta0d32548802e608c2b0d984006221d439cb1a035 (diff)
parent9c10763fedf5103bbd229648b17ee4a36d70e89e (diff)
Merge "[docs] Make heading levels consistent"
Diffstat (limited to 'docs/testing/user/userguide/01-introduction.rst')
-rwxr-xr-xdocs/testing/user/userguide/01-introduction.rst20
1 files changed, 15 insertions, 5 deletions
diff --git a/docs/testing/user/userguide/01-introduction.rst b/docs/testing/user/userguide/01-introduction.rst
index 5fc2e8d0f..2a3ab4ea7 100755
--- 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
@@ -32,7 +42,7 @@ independent.
About This Document
-===================
+-------------------
This document consists of the following chapters:
@@ -79,7 +89,7 @@ This document consists of the following chapters:
cases.
Contact Yardstick
-=================
+-----------------
Feedback? `Contact us`_