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>

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 70e98ad..44a543c 100644 (file)
--- 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.
 
 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?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Why reStructuredText/Sphinx?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/docs/guides/onap-developer/how-to-use-docs/setting-up.rst b/docs/guides/onap-developer/how-to-use-docs/setting-up.rst
index 91f5309..d9f87af 100644 (file)
--- a/docs/guides/onap-developer/how-to-use-docs/setting-up.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/setting-up.rst
@@ -295,6 +295,15 @@ release. In this context:
 Creating Restructured Text
 ==========================
 
 Creating Restructured Text
 ==========================
 

+ReStructuredText markup conventions
+-----------------------------------
+For detailed information on 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>`_
+
+

 Templates and Examples
 ----------------------
 Templates are available that capture the kinds of information
 Templates and Examples
 ----------------------
 Templates are available that capture the kinds of information


@@ -477,8 +486,8 @@ Change directory to doc & install requirements.
 
 .. warning::
 
 
 .. warning::
 

-       Just follow the next step (copying conf.py from Doc project to your project) 
-       if that is your intention, otherwise skip it. Currently all projects should already have a conf.py file. 
+       Just follow the next step (copying conf.py from Doc project to your project)
+       if that is your intention, otherwise skip it. Currently all projects should already have a conf.py file.

        Through the next step, this file and potential extensions in your project get overriden.
 
 Copy the conf.py file to your project folder where RST files have been kept:
        Through the next step, this file and potential extensions in your project get overriden.
 
 Copy the conf.py file to your project folder where RST files have been kept:

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 3246885..dcd1552 100644 (file)
--- 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.
 
 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
 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
    * - 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

-