summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer/how-to-use-docs/style-guide.rst
diff options
context:
space:
mode:
authorAndrea Visnyei <andrea.visnyei@nokia.com>2020-09-25 12:23:47 +0200
committerAndrea Visnyei <andrea.visnyei@nokia.com>2020-10-01 12:34:33 +0200
commita2eb2e21c26309f52c2942ef6515ce708540c78b (patch)
treeca17e50acdbe04cb062fc48d27a8d0448efd27e7 /docs/guides/onap-developer/how-to-use-docs/style-guide.rst
parentc847e4ef2a410ea91a4ec49c7c15bc19b87051ac (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/style-guide.rst')
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/style-guide.rst25
1 files changed, 0 insertions, 25 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/style-guide.rst b/docs/guides/onap-developer/how-to-use-docs/style-guide.rst
index 324688551..dcd1552bf 100644
--- a/docs/guides/onap-developer/how-to-use-docs/style-guide.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/style-guide.rst
@@ -8,30 +8,6 @@ Style guide
This style guide is for ONAP documentation contributors, reviewers and
committers.
-Getting started
----------------
-
-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
-
-ReStructuredText markup conventions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-For detailed information ReStructuredText and how to best use the format, see:
-
-- `ReStructured Text Primer <http://docutils.sourceforge.net/docs/user/rst/quickstart.html>`_
-- `ReStructured Text Quick Reference <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_
-
Writing guidelines
------------------
Following these writing guidelines will keep ONAP documentation
@@ -141,4 +117,3 @@ Needs Directive
* - R
- Represents a requirement that must be met by a VNF provider
- Defined only in the vnfrqts project repositories, may be referenced in any project repository source
-