Merge "Remove remaining warnings during Documentation buildings"

3 files changed, 76 insertions, 131 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 ceb2eb0e6..250313fc4 100644
--- a/docs/guides/onap-developer/how-to-use-docs/introduction.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/introduction.rst
@@ -108,81 +108,77 @@ reference parts of source for documentation from other project
 repositories.  Other ONAP projects will provide content that
 is referenced from this structure.
 
-::
-
-docs
-├── guides
-│   ├── active-projects
-│   ├── onap-developer
-│   │   ├── apiref
-│   │   ├── architecture
-│   │   │   └── media
-│   │   ├── developing
-│   │   ├── how-to-use-docs
-│   │   ├── tutorials
-│   │   └── use-cases
-│   ├── onap-operator
-│   │   ├── cloud_site
-│   │   │   ├── aws
-│   │   │   ├── azure
-│   │   │   ├── k8s
-│   │   │   ├── openstack
-│   │   │   └── vmware
-│   │   ├── onap-portal-admin
-│   │   │   └── attachments
-│   │   └── settingup
-│   ├── onap-provider
-│   ├── onap-user
-│   │   ├── configure
-│   │   │   ├── change_config
-│   │   │   ├── pnf_connect
-│   │   │   └── vnf_connect
-│   │   ├── design
-│   │   │   ├── control-loop
-│   │   │   │   └── media
-│   │   │   ├── media
-│   │   │   ├── parameter_resolution
-│   │   │   │   └── ubuntu_example
-│   │   │   │       ├── cba-after-enrichment
-│   │   │   │       │   ├── Definitions
-│   │   │   │       │   ├── Templates
-│   │   │   │       │   └── TOSCA-Metadata
-│   │   │   │       ├── cba-before-enrichment
-│   │   │   │       │   ├── Definitions
-│   │   │   │       │   ├── Templates
-│   │   │   │       │   └── TOSCA-Metadata
-│   │   │   │       └── ubuntuCDS_heat
-│   │   │   ├── pre-onboarding
-│   │   │   │   └── media
-│   │   │   ├── resource-onboarding
-│   │   │   │   └── media
-│   │   │   ├── service-design
-│   │   │   │   └── media
-│   │   │   ├── service-distribution
-│   │   │   │   └── media
-│   │   │   └── vfcreation
-│   │   │       └── media
-│   │   ├── instantiate
-│   │   │   ├── instantiation
-│   │   │   │   ├── nbi
-│   │   │   │   ├── pnf_instance
-│   │   │   │   ├── service_instance
-│   │   │   │   ├── so1
-│   │   │   │   ├── so2
-│   │   │   │   ├── uui
-│   │   │   │   ├── vid
-│   │   │   │   ├── virtual_link_instance
-│   │   │   │   └── vnf_instance
-│   │   │   └── pre_instantiation
-│   │   └── onap-portal-user
-│   │       └── attachments
-│   └── overview
-│       └── media
-├── release
-├── templates
-│   ├── collections
-│   └── sections
-└── use-cases
+.. code-block::
+
+   docs
+   ├── guides
+   │   ├── onap-developer
+   │   │   ├── apiref
+   │   │   ├── architecture
+   │   │   │   └── media
+   │   │   ├── developing
+   │   │   └── how-to-use-docs
+   |   |   |   ├── templates
+   │   |   |   |   ├── collections
+   │   |   |   |   └── sections
+   │   ├── onap-operator
+   │   │   ├── cloud_site
+   │   │   │   ├── aws
+   │   │   │   ├── azure
+   │   │   │   ├── k8s
+   │   │   │   ├── openstack
+   │   │   │   └── vmware
+   │   │   ├── onap-portal-admin
+   │   │   │   └── attachments
+   │   │   └── settingup
+   │   ├── onap-provider
+   │   ├── onap-user
+   │   │   ├── configure
+   │   │   │   ├── change_config
+   │   │   │   ├── pnf_connect
+   │   │   │   └── vnf_connect
+   │   │   ├── design
+   │   │   │   ├── control-loop
+   │   │   │   │   └── media
+   │   │   │   ├── media
+   │   │   │   ├── parameter_resolution
+   │   │   │   │   └── ubuntu_example
+   │   │   │   │       ├── cba-after-enrichment
+   │   │   │   │       │   ├── Definitions
+   │   │   │   │       │   ├── Templates
+   │   │   │   │       │   └── TOSCA-Metadata
+   │   │   │   │       ├── cba-before-enrichment
+   │   │   │   │       │   ├── Definitions
+   │   │   │   │       │   ├── Templates
+   │   │   │   │       │   └── TOSCA-Metadata
+   │   │   │   │       └── ubuntuCDS_heat
+   │   │   │   ├── pre-onboarding
+   │   │   │   │   └── media
+   │   │   │   ├── resource-onboarding
+   │   │   │   │   └── media
+   │   │   │   ├── service-design
+   │   │   │   │   └── media
+   │   │   │   ├── service-distribution
+   │   │   │   │   └── media
+   │   │   │   └── vfcreation
+   │   │   │       └── media
+   │   │   ├── instantiate
+   │   │   │   ├── instantiation
+   │   │   │   │   ├── nbi
+   │   │   │   │   ├── pnf_instance
+   │   │   │   │   ├── service_instance
+   │   │   │   │   ├── so1
+   │   │   │   │   ├── so2
+   │   │   │   │   ├── uui
+   │   │   │   │   ├── vid
+   │   │   │   │   ├── virtual_link_instance
+   │   │   │   │   └── vnf_instance
+   │   │   │   └── pre_instantiation
+   │   │   └── onap-portal-user
+   │   │       └── attachments
+   │   └── overview
+   │       └── media
+   └── release
 
 
 Source Files
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 cafa4790a..509e7aff1 100644
--- a/docs/guides/onap-developer/how-to-use-docs/setting-up.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/setting-up.rst
@@ -332,59 +332,12 @@ for a particular type of project, repository, guide, reference manual, etc.
 For example, a collection for a platform component, an SDK, etc.
 
 You can: browse the template *collections* and *sections* below;
-show source to look at the Restructured Text and Sphinx directives used;
-copy the source either from a browser window or by downloading the
-file in raw form from
-the `gerrit doc repository <https://gerrit.onap.org/r/gitweb?p=doc.git;a=tree;f=docs/templates;/>`_ and
-then add them to your repository docs folder and index.rst.
-
+show source to look at the Restructured Text and Sphinx directives used.
 
 Sections
 ++++++++
 
-
-+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|Sections                                                                                                              |Description                                                                                                                                                                                           |
-+======================================================================================================================+======================================================================================================================================================================================================+
-|`Administration <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/administration.rst>`_    | This section is used to describe a software component from the perspective of on-going operation including regular processes and actions that are taken to configure and manage the component.       |
-|                                                                                                                      |                                                                                                                                                                                                      |
-+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|`Architecture <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/architecture.rst>`_        | This section is used to describe a software component from a high level view of capability, common usage scenarios, and interactions with other components required in the usage scenarios.          |
-|                                                                                                                      |                                                                                                                                                                                                      |
-+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|`Build <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/build.rst>`_                      | This section is used to describe how a software component is built from source into something ready for use either in a run-time environment or to build other components.                           |
-|                                                                                                                      |                                                                                                                                                                                                      |
-+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|`Configuration <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/configuration.rst>`_      | This section is used to describe the options a software component offers for configuration.                                                                                                          |
-|                                                                                                                      |                                                                                                                                                                                                      |
-+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|`Consumed APIs <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/consumedapis.rst>`_       | This section is used to reference APIs that a software component depends on and uses from other sources.                                                                                             |
-|                                                                                                                      |                                                                                                                                                                                                      |
-+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|`Delivery <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/delivery.rst>`_                | This section is used to describe a software component packaging. For a run-time component this might be executable images, containers, etc. For an SDK this might be libraries.                      |
-|                                                                                                                      |                                                                                                                                                                                                      |
-+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|`Design <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/design.rst>`_                    | This section is used to describe the internal design structure of a software component.                                                                                                              |
-|                                                                                                                      |                                                                                                                                                                                                      |
-+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|`Human interfaces <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/humaninterfaces.rst>`_ |This section is used to describe a software component's command line and graphical user interfaces.                                                                                                   |
-|                                                                                                                      |                                                                                                                                                                                                      |
-+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|`Installation <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/installation.rst>`_        | This section is used to describe how a software component is acquired and installed.                                                                                                                 |
-|                                                                                                                      |                                                                                                                                                                                                      |
-+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|`Logging <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/logging.rst>`_                  | This section is used to describe the informational or diagnostic messages emitted from a software component and the methods or collecting them.                                                      |
-|                                                                                                                      |                                                                                                                                                                                                      |
-+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|`Offered APIs <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/offeredapis.rst>`_         | This section is used to describe the external interfaces offered by a software component                                                                                                             |
-|                                                                                                                      |                                                                                                                                                                                                      |
-+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|`Release notes <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/release-notes.rst>`_      | The release note needs to be updated for each ONAP release                                                                                                                                           |
-|                                                                                                                      |                                                                                                                                                                                                      |
-+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|`VNF reference <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/vnf-reference.rst>`_      | This section is used to describe Virtual Network Function software                                                                                                                                   |
-|                                                                                                                      |                                                                                                                                                                                                      |
-+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+Section examples are available here: :ref:`Templates<templates>`
 
 Collections
 +++++++++++
@@ -410,13 +363,7 @@ content that can be used as is or easily converted, and use of Sphinx
 directives/extensions to automatically generate restructured text
 from other source you already have.
 
-+------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
-|Collections                                                                                                                   |Description                                                 |
-+==============================================================================================================================+============================================================+
-|`Platform component <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/collections/platform-component.rst>`_ | This collection is used to describe a platform component.  |
-+------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
-|`SDK <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/collections/sdk.rst>`_                               | This collection is used to describe an SDK.                |
-+------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
+Collection examples are available here: :ref:`Templates<templates>`
 
 Links and References
 --------------------
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates.rst b/docs/guides/onap-developer/how-to-use-docs/templates.rst
index 73b60666b..42dd6ac22 100644
--- a/docs/guides/onap-developer/how-to-use-docs/templates.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/templates.rst
@@ -2,6 +2,8 @@
 .. International License. http://creativecommons.org/licenses/by/4.0
 .. Copyright 2020 ONAP community
 
+.. _templates:
+
 Templates
 =========