summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst19
1 files changed, 18 insertions, 1 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index d3e21b80..6350a862 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -56,6 +56,22 @@ Specially, it is recommended to link each patch set with a JIRA issue. Put
in commit message to create an automatic link.
+*************
+Documentation
+*************
+
+The documents are built automatically by sphinx from reStructuredText (reST).
+Please read `reStructuredText Primer`_ if you are not familiar with it.
+
+A cheat sheet for headings are as following
+
+* # with overline, for parts
+* * with overline, for chapters
+* =, for sections
+* -, for subsections
+* ^, for subsubsections
+* ", for paragraphs
+
************************
Frequent Asked Questions
************************
@@ -76,4 +92,5 @@ to submit. The current members are listed in `INFO`_.
.. _OPNFV Releases: https://wiki.opnfv.org/display/SWREL
.. _Issue Types: https://jira.opnfv.org/secure/ShowConstantsHelp.jspa?decorator=popup#IssueTypes
.. _OpenStack Style Guidelines: http://docs.openstack.org/developer/hacking/
-.. _INFO: https://git.opnfv.org/cgit/qtip/tree/INFO \ No newline at end of file
+.. _INFO: https://git.opnfv.org/cgit/qtip/tree/INFO
+.. _reStructuredText Primer: http://www.sphinx-doc.org/en/stable/rest.html