[docs] Update header levels

[yardstick.git] / docs / release / results / overview.rst

diff --git a/docs/release/results/overview.rst b/docs/release/results/overview.rst
index 9fd7479..b5e6a43 100644 (file)
--- a/docs/release/results/overview.rst
+++ b/docs/release/results/overview.rst
@@ -3,6 +3,15 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) OPNFV, Ericsson AB and others.
 
+..
+      Convention for heading levels in Yardstick:
+      =======  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 test tesult document overview
 =======================================