summaryrefslogtreecommitdiffstats
path: root/docs/templates
diff options
context:
space:
mode:
authorEmma Foley <emma.l.foley@intel.com>2018-10-03 13:49:21 +0100
committerEmma Foley <emma.l.foley@intel.com>2018-10-30 19:27:39 +0000
commit5456b070a8e05cd49d5626b002f6eeee71bcd67d (patch)
tree8f85f392470f22bdca194cdfaec0e76dfdf430d0 /docs/templates
parent766d498f9f4abcb79710d077c6a1886ae11a4c0a (diff)
[docs] Update header levels
JIRA: YARDSTICK-1335 Change-Id: I202634a7427a409f0e2ca786c8bb5e05a5b4351d Signed-off-by: Emma Foley <emma.l.foley@intel.com>
Diffstat (limited to 'docs/templates')
-rw-r--r--docs/templates/test_results_template.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/templates/test_results_template.rst b/docs/templates/test_results_template.rst
index f04b2b2a8..4523563a1 100644
--- a/docs/templates/test_results_template.rst
+++ b/docs/templates/test_results_template.rst
@@ -1,3 +1,18 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+
+..
+ 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 Test Report
=====================