diff options
| author |   Andrea Visnyei <andrea.visnyei@nokia.com> | 2020-09-25 12:23:47 +0200 |
|---|---|---|
| committer | Andrea Visnyei <andrea.visnyei@nokia.com> | 2020-10-01 12:34:33 +0200 |
| commit | a2eb2e21c26309f52c2942ef6515ce708540c78b (patch) | |
| tree | ca17e50acdbe04cb062fc48d27a8d0448efd27e7 /docs/guides/onap-developer/how-to-use-docs/introduction.rst | |
| parent | c847e4ef2a410ea91a4ec49c7c15bc19b87051ac (diff) | |
Moving section from style guide to other chapters
Moved 2 sections to Introduction.
Moved 1 section to Setting up/Creating Restructured Text.
Issue-ID: DOC-670
Change-Id: I2b147d7e54f1b8e5f10521734b86531e66ad2c68
Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs/introduction.rst')
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/introduction.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/introduction.rst b/docs/guides/onap-developer/how-to-use-docs/introduction.rst index 70e98ad93..44a543c34 100644 --- a/docs/guides/onap-developer/how-to-use-docs/introduction.rst +++ b/docs/guides/onap-developer/how-to-use-docs/introduction.rst @@ -17,6 +17,20 @@ Much of the content in this document is derived from similar documentation processes used in other Linux Foundation Projects including OPNFV and Open Daylight. +When is documentation required? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +All ONAP project contributions should have corresponding documentation. +This includes all new features and changes to features that impact users. + +How do I create ONAP documentation? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +ONAP documentation is written in ReStructuredText_ (an easy-to-read, +what-you-see-is-what-you-get, plain text markup syntax). The process for +creating ONAP documentation and what documents are required are +described in later sections of this Developer Documentation Guide. + +.. _ReStructuredText: http://docutils.sourceforge.net/rst.html + Why reStructuredText/Sphinx? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |