summaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide/04-installation.rst
diff options
context:
space:
mode:
authorEmma Foley <emma.l.foley@intel.com>2018-10-03 13:49:21 +0100
committerRex Lee <limingjiang@huawei.com>2018-11-09 17:03:16 +0000
commitfb2a2081c0904f38e762e375c3403cf3cae2cd75 (patch)
tree2f5c3bb3ccd56090fd059a31b24f4fd008cd4cd7 /docs/testing/user/userguide/04-installation.rst
parent73a32b87c4f9004d22e67a981812e0a934e821f3 (diff)
[docs] Update header levels
JIRA: YARDSTICK-1335 Change-Id: I202634a7427a409f0e2ca786c8bb5e05a5b4351d Signed-off-by: Emma Foley <emma.l.foley@intel.com> (cherry picked from commit 5456b070a8e05cd49d5626b002f6eeee71bcd67d)
Diffstat (limited to 'docs/testing/user/userguide/04-installation.rst')
-rw-r--r--docs/testing/user/userguide/04-installation.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/testing/user/userguide/04-installation.rst b/docs/testing/user/userguide/04-installation.rst
index d97078909..6b3259299 100644
--- a/docs/testing/user/userguide/04-installation.rst
+++ b/docs/testing/user/userguide/04-installation.rst
@@ -3,6 +3,17 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Ericsson AB, Huawei Technologies Co.,Ltd 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.
+
======================
Yardstick Installation
======================