Remove remaining warnings during Documentation buildings

correct files to remove warnings
Remove orphan links
Correct bad links

Issue-ID: DOC-692

Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Change-Id: Iac1fea50a4edaf6ef38b97a1b5d689fab0206a15

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 ceb2eb0..250313f 100644 (file)
--- 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.
 
 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
 
 
 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 cafa479..509e7af 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
@@ -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;
 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
 ++++++++
 

-
-+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|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
 +++++++++++
 
 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.
 
 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
 --------------------
 
 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 73b6066..42dd6ac 100644 (file)
--- 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
 
 .. International License. http://creativecommons.org/licenses/by/4.0
 .. Copyright 2020 ONAP community
 

+.. _templates:
+

 Templates
 =========
 
 Templates
 =========
 

diff --git a/docs/guides/onap-user/design/resource-onboarding/index.rst b/docs/guides/onap-user/design/resource-onboarding/index.rst
index 2c7020d..07fd80a 100644 (file)
--- a/docs/guides/onap-user/design/resource-onboarding/index.rst
+++ b/docs/guides/onap-user/design/resource-onboarding/index.rst
@@ -87,7 +87,7 @@ Create a License Key Group [Optional]
 If required by the resource model, create one or more license key groups;
 otherwise the license key group is optional.
 
 If required by the resource model, create one or more license key groups;
 otherwise the license key group is optional.
 

-**Prerequisites:** `Create a License Model`_
+**Prerequisites:** `Create a License Model [Optional]`_

 
 #. Select the License Model in the Onboard section of the SDC.
 #. In the Overview click the + inside the License Key Groups OR Navigate to License Key Groups and click on “+ ADD LICENSE KEY GROUP”
 
 #. Select the License Model in the Onboard section of the SDC.
 #. In the Overview click the + inside the License Key Groups OR Navigate to License Key Groups and click on “+ ADD LICENSE KEY GROUP”


@@ -152,7 +152,7 @@ Create a License Agreement
     * Select one or more groups in the Available Feature Groups, select one or more feature groups and click on the “>” sign.
     * Selected feature groups should now be seen under the Selected Feature Groups.
 #. Click *Save*.
     * Select one or more groups in the Available Feature Groups, select one or more feature groups and click on the “>” sign.
     * Selected feature groups should now be seen under the Selected Feature Groups.
 #. Click *Save*.

-#. Return to step 6 of `Create a License Model`_ to complete the license model.
+#. Return to step 6 of `Create a License Model [Optional]`_ to complete the license model.

 
 .. _doc_guide_user_des_res-onb_cre-vsp:
 
 
 .. _doc_guide_user_des_res-onb_cre-vsp:
 


@@ -167,7 +167,7 @@ for VFs/PNFs.
 
 **Prerequisites:**
 
 
 **Prerequisites:**
 

-* `Create a License Model`_
+* `Create a License Model [Optional]`_

 * VNF HEAT package or VNF/PNF CSAR/Zip package is available.
 
   See :ref:`sdc_onboarding_package_types` for a description
 * VNF HEAT package or VNF/PNF CSAR/Zip package is available.
 
   See :ref:`sdc_onboarding_package_types` for a description


@@ -175,7 +175,7 @@ for VFs/PNFs.
 * If the package is a secure package then :ref:`pre-install the corresponding Root Certificate in SDC <doc_guide_user_des_res-onb_pre-install_root_certificate>`.
 
 .. note::
 * If the package is a secure package then :ref:`pre-install the corresponding Root Certificate in SDC <doc_guide_user_des_res-onb_pre-install_root_certificate>`.
 
 .. note::

-   Example packages can be found in the SDC project: `example-packages`_
+   Example packages can be found in the SDC project: :ref:`SDC Packages<onap-sdc:sdc_onboarding_package_types>`

 
 #. From the SDC HOME page, click *ONBOARD*.
 
 
 #. From the SDC HOME page, click *ONBOARD*.
 

diff --git a/docs/guides/onap-user/design/service-design/index.rst b/docs/guides/onap-user/design/service-design/index.rst
index ce7fb9a..a133799 100644 (file)
--- a/docs/guides/onap-user/design/service-design/index.rst
+++ b/docs/guides/onap-user/design/service-design/index.rst
@@ -93,12 +93,11 @@ Create Service
      action)
    - **Management Workflow** model service lifecycle workflows for execution
      in SO (see `Create a Management Workflow [optional]`_)
      action)
    - **Management Workflow** model service lifecycle workflows for execution
      in SO (see `Create a Management Workflow [optional]`_)

-   - **Network Call Flow** model interactions among VFs (see `Create a
-      Network Callflow [optional]`_)
+   - **Network Call Flow** model interactions among VFs (see
+     `Create a Network Callflow [optional]`_)

    - **Deployment** view HEAT modules in VSPs
    - **Properties Assignment** define or update properties,
    - **Deployment** view HEAT modules in VSPs
    - **Properties Assignment** define or update properties,

-     policies and input parameters used during Service instantiation
-     (see `Add Service Inputs [optional]`_).
+     policies and input parameters used during Service instantiation.

    - **Monitoring** ...
 
 #. Click *Check In* to save changes.
    - **Monitoring** ...
 
 #. Click *Check In* to save changes.


@@ -284,8 +283,7 @@ updated (see step 4).
 #. [Optional] Click *Network Callflow* to edit the interactions among VFs
    that comprise the service (see `Create a Network Callflow [optional]`_).
 #. [Optional] Click *Properties Assignement* to select parameters as
 #. [Optional] Click *Network Callflow* to edit the interactions among VFs
    that comprise the service (see `Create a Network Callflow [optional]`_).
 #. [Optional] Click *Properties Assignement* to select parameters as

-   input fields during Service instantiation
-   (see `Add Service Inputs [optional]`_).
+   input fields during Service instantiation.

 #. Click *Check In* to save changes.
 #. After updating a service and configuring optional fields, certify it
    (see `Certify Service`_).
 #. Click *Check In* to save changes.
 #. After updating a service and configuring optional fields, certify it
    (see `Certify Service`_).

diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst
index d8432fb..ee754d2 100644 (file)
--- a/docs/guides/onap-user/index.rst
+++ b/docs/guides/onap-user/index.rst
@@ -27,4 +27,4 @@ In the following page you find all use cases and functional requirements
 which have been officially verified in the actual release by the ONAP community.
 
 * :ref:`Guilin Use Cases<onap-integration:docs_usecases_release>`
 which have been officially verified in the actual release by the ONAP community.
 
 * :ref:`Guilin Use Cases<onap-integration:docs_usecases_release>`

-* :ref:`Deprecated Use Cases<onap-integration:docs_usecases>`
+* :ref:`Deprecated Use Cases<onap-integration:docs_usecases>`
\ No newline at end of file

diff --git a/docs/release/index.rst b/docs/release/index.rst
index 7c81596..1038209 100644 (file)
--- a/docs/release/index.rst
+++ b/docs/release/index.rst
@@ -186,7 +186,7 @@ Others
 
 .. important::
    Some non-functional requirements are not fully finalized. Please, check details
 
 .. important::
    Some non-functional requirements are not fully finalized. Please, check details

-   on the :ref:`Integration<onap-integration>`
+   on the :ref:`Integration<onap-integration:release_non_functional_requirements>`

 
 
 Project Specific Release Notes
 
 
 Project Specific Release Notes