Correct Documentation display for bullet list

The new internal sphinx links auto-geenrated had some impacts
on the display for some pages.

This patch correct the RST files by adding some bullet lists
guides/onap-developer/apiref/index.rst
guides/onap-provider/index.rst
guides/onap-provider/vnfvalidator.rst

Provide better description for the links

Issue-ID: DOC-619

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

diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst
index fc7ddcd..aef10bf 100644 (file)
--- a/docs/guides/onap-developer/apiref/index.rst
+++ b/docs/guides/onap-developer/apiref/index.rst
@@ -20,10 +20,10 @@ User Interfaces
    :maxdepth: 1
    :titlesonly:
 
-:ref:`CLAMP - Closed Loop Automation Platform<onap-clamp:master_index>`
-:ref:`Portal<onap-portal:offeredapis>`
-:ref:`SDC - Service Design and Creation<onap-sdc:offeredapis>`
-:ref:`VID - Virtual Infrastructure Deployment<onap-vid:offeredapis>`
+* :ref:`CLAMP - Closed Loop Automation Platform<onap-clamp:master_index>`
+* :ref:`Portal<onap-portal:offeredapis>`
+* :ref:`SDC - Service Design and Creation<onap-sdc:offeredapis>`
+* :ref:`VID - Virtual Infrastructure Deployment<onap-vid:offeredapis>`
 
 Platform Components
 -------------------
@@ -32,13 +32,13 @@ Platform Components
    :maxdepth: 1
    :titlesonly:
 
-:ref:`APPC - Application Controller<onap-appc:appc_lcm_api_guide>`
-:ref:`DCAE - Data Collection Analytics and Events<onap-dcaegen2:offeredapis>`
-:ref:`Holmes - Alarm Correlation<onap-holmes-rule-management:offeredapis>`
-:ref:`Policy<onap-policy-parent:offeredapis>`
-:ref:`SDNC - SDN Controller<onap-sdnc-oam:offeredapis>`
-:ref:`SO - Service Orchestration<onap-so:offeredapis>`
-:ref:`VFC - Virtual Function Controller<onap-vfc-nfvo-lcm:master_index>`
+* :ref:`APPC - Application Controller<onap-appc:appc_lcm_api_guide>`
+* :ref:`DCAE - Data Collection Analytics and Events<onap-dcaegen2:offeredapis>`
+* :ref:`Holmes - Alarm Correlation<onap-holmes-rule-management:offeredapis>`
+* :ref:`Policy<onap-policy-parent:offeredapis>`
+* :ref:`SDNC - SDN Controller<onap-sdnc-oam:offeredapis>`
+* :ref:`SO - Service Orchestration<onap-so:offeredapis>`
+* :ref:`VFC - Virtual Function Controller<onap-vfc-nfvo-lcm:master_index>`
 
 Common Services
 ---------------
@@ -47,18 +47,18 @@ Common Services
    :maxdepth: 1
    :titlesonly:
 
-:ref:`AAF - Application Authorization Framework<onap-aaf-sms:offeredapis>`
-:ref:`AAI - Active and Available Inventory<onap-aai-aai-common:offeredapis>`
-:ref:`AAI ESR - AAI External System Register<onap-aai-esr-server:offeredapis>`
-:ref:`DMAAP DBC - Data Management as a Platform (Data Bus Controller)<onap-dmaap-dbcapi:offeredapis>`
-:ref:`DMAAP DR - Data Management as a Platform (Data Router)<onap-dmaap-datarouter:master_index>`
-:ref:`DMAAP MR - Data Management as a Platform (Message Router)<onap-dmaap-messagerouter-messageservice:offeredapis>`
-:ref:`ExtAPI- External API NBI - NorthBound API<onap-externalapi-nbi:offeredapis>`
-:ref:`Modeling Parsers<onap-modeling-toscaparsers:offeredapis>`
-:ref:`MSB - Micro Services Bus<onap-msb-apigateway:offeredapis>`
-:ref:`Multi Cloud<onap-multicloud-framework:offeredapis>`
-:ref:`MUSIC - Multi-site State Coordination Service<onap-music:offeredapis>`
-:ref:`OPTF - Optimization Framework<onap-optf-osdf:offeredapis>`
+* :ref:`AAF - Application Authorization Framework<onap-aaf-sms:offeredapis>`
+* :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:offeredapis>`
+* :ref:`AAI ESR - AAI External System Register<onap-aai-esr-server:offeredapis>`
+* :ref:`DMAAP DBC - Data Management as a Platform (Data Bus Controller)<onap-dmaap-dbcapi:offeredapis>`
+* :ref:`DMAAP DR - Data Management as a Platform (Data Router)<onap-dmaap-datarouter:master_index>`
+* :ref:`DMAAP MR - Data Management as a Platform (Message Router)<onap-dmaap-messagerouter-messageservice:offeredapis>`
+* :ref:`ExtAPI- External API NBI - NorthBound API<onap-externalapi-nbi:offeredapis>`
+* :ref:`Modeling Parsers<onap-modeling-toscaparsers:offeredapis>`
+* :ref:`MSB - Micro Services Bus<onap-msb-apigateway:offeredapis>`
+* :ref:`Multi Cloud<onap-multicloud-framework:offeredapis>`
+* :ref:`MUSIC - Multi-site State Coordination Service<onap-music:offeredapis>`
+* :ref:`OPTF - Optimization Framework<onap-optf-osdf:offeredapis>`
 
 SDK
 ---
@@ -67,7 +67,7 @@ SDK
    :maxdepth: 1
    :titlesonly:
 
-:ref:`VNF Software Development Kit<onap-vnfsdk-model:offeredapis>`
+* :ref:`VNF Software Development Kit<onap-vnfsdk-model:offeredapis>`
 
 
 Some ONAP Postman collections
@@ -77,4 +77,4 @@ Some ONAP Postman collections
    :maxdepth: 1
    :titlesonly:
 
-:ref:`Some ONAP Postman collections<onap-integration:docs_postman>`
+* :ref:`Some ONAP Postman collections<onap-integration:docs_postman>`

diff --git a/docs/guides/onap-provider/index.rst b/docs/guides/onap-provider/index.rst
index efea37a..b24a1ed 100644 (file)
--- a/docs/guides/onap-provider/index.rst
+++ b/docs/guides/onap-provider/index.rst
@@ -7,15 +7,15 @@
 VNF and PNF Requirements and Guidelines
 =======================================
 
-The following includes guides and requirements are provided to
+The following includes guides and requirements to
 describe tasks that an VNF or PNF provider of ONAP may need to properly
 set up an VNF or PNF for ONAP usage.
 
 .. toctree::
    :maxdepth: 2
 
-:ref:`vnfrqts guidelines<onap-vnfrqts-guidelines:master_index>`
-:ref:`vnfrqts requirements<onap-vnfrqts-requirements:master_index>`
-:ref:`vnfrqts testcases<onap-vnfrqts-testcases:master_index>`
-:ref:`vnfrqts usecases<onap-vnfrqts-usecases:master_index>`
-:ref:`vnfrqts requirements docs release-notes<onap-vnfrqts-requirements:release_notes>`
+* :ref:`VNF Guidelines<onap-vnfrqts-guidelines:master_index>`
+* :ref:`VNF or PNF Requirements Documentation<onap-vnfrqts-requirements:master_index>`
+* :ref:`VNF Test Case Descriptions<onap-vnfrqts-testcases:master_index>`
+* :ref:`VNF Provider Use Cases<onap-vnfrqts-usecases:master_index>`
+* :ref:`VNFRQTS Project Release Notes<onap-vnfrqts-requirements:release_notes>`

diff --git a/docs/guides/onap-provider/vnfvalidator.rst b/docs/guides/onap-provider/vnfvalidator.rst
index 9a80e3e..854f06c 100644 (file)
--- a/docs/guides/onap-provider/vnfvalidator.rst
+++ b/docs/guides/onap-provider/vnfvalidator.rst
@@ -1,4 +1,5 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License.
 
 VNF Validation Documentation
 ============================
@@ -6,6 +7,5 @@ VNF Validation Documentation
 .. toctree::
    :maxdepth: 2
 
-:ref:`vvp documentation<onap-vvp-documentation:master_index>`
-
-:ref:`vvp documentation release-notes<onap-vvp-documentation:release_notes>`
+* :ref:`vvp documentation<onap-vvp-documentation:master_index>`
+* :ref:`vvp documentation release-notes<onap-vvp-documentation:release_notes>`