From 329527e76aa37eb7b8bdecf0e20d555f637cb424 Mon Sep 17 00:00:00 2001 From: Eric Debeau Date: Tue, 26 May 2020 14:10:04 +0200 Subject: [PATCH] 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 Change-Id: I4944a294516b90fbdfa998a623104ac6a85f3fe3 --- docs/guides/onap-developer/apiref/index.rst | 50 ++++++++++++++--------------- docs/guides/onap-provider/index.rst | 12 +++---- docs/guides/onap-provider/vnfvalidator.rst | 8 ++--- 3 files changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst index fc7ddcdfb..aef10bf30 100644 --- 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` -:ref:`Portal` -:ref:`SDC - Service Design and Creation` -:ref:`VID - Virtual Infrastructure Deployment` +* :ref:`CLAMP - Closed Loop Automation Platform` +* :ref:`Portal` +* :ref:`SDC - Service Design and Creation` +* :ref:`VID - Virtual Infrastructure Deployment` Platform Components ------------------- @@ -32,13 +32,13 @@ Platform Components :maxdepth: 1 :titlesonly: -:ref:`APPC - Application Controller` -:ref:`DCAE - Data Collection Analytics and Events` -:ref:`Holmes - Alarm Correlation` -:ref:`Policy` -:ref:`SDNC - SDN Controller` -:ref:`SO - Service Orchestration` -:ref:`VFC - Virtual Function Controller` +* :ref:`APPC - Application Controller` +* :ref:`DCAE - Data Collection Analytics and Events` +* :ref:`Holmes - Alarm Correlation` +* :ref:`Policy` +* :ref:`SDNC - SDN Controller` +* :ref:`SO - Service Orchestration` +* :ref:`VFC - Virtual Function Controller` Common Services --------------- @@ -47,18 +47,18 @@ Common Services :maxdepth: 1 :titlesonly: -:ref:`AAF - Application Authorization Framework` -:ref:`AAI - Active and Available Inventory` -:ref:`AAI ESR - AAI External System Register` -:ref:`DMAAP DBC - Data Management as a Platform (Data Bus Controller)` -:ref:`DMAAP DR - Data Management as a Platform (Data Router)` -:ref:`DMAAP MR - Data Management as a Platform (Message Router)` -:ref:`ExtAPI- External API NBI - NorthBound API` -:ref:`Modeling Parsers` -:ref:`MSB - Micro Services Bus` -:ref:`Multi Cloud` -:ref:`MUSIC - Multi-site State Coordination Service` -:ref:`OPTF - Optimization Framework` +* :ref:`AAF - Application Authorization Framework` +* :ref:`AAI - Active and Available Inventory` +* :ref:`AAI ESR - AAI External System Register` +* :ref:`DMAAP DBC - Data Management as a Platform (Data Bus Controller)` +* :ref:`DMAAP DR - Data Management as a Platform (Data Router)` +* :ref:`DMAAP MR - Data Management as a Platform (Message Router)` +* :ref:`ExtAPI- External API NBI - NorthBound API` +* :ref:`Modeling Parsers` +* :ref:`MSB - Micro Services Bus` +* :ref:`Multi Cloud` +* :ref:`MUSIC - Multi-site State Coordination Service` +* :ref:`OPTF - Optimization Framework` SDK --- @@ -67,7 +67,7 @@ SDK :maxdepth: 1 :titlesonly: -:ref:`VNF Software Development Kit` +* :ref:`VNF Software Development Kit` Some ONAP Postman collections @@ -77,4 +77,4 @@ Some ONAP Postman collections :maxdepth: 1 :titlesonly: -:ref:`Some ONAP Postman collections` +* :ref:`Some ONAP Postman collections` diff --git a/docs/guides/onap-provider/index.rst b/docs/guides/onap-provider/index.rst index efea37aa3..b24a1eda7 100644 --- 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` -:ref:`vnfrqts requirements` -:ref:`vnfrqts testcases` -:ref:`vnfrqts usecases` -:ref:`vnfrqts requirements docs release-notes` +* :ref:`VNF Guidelines` +* :ref:`VNF or PNF Requirements Documentation` +* :ref:`VNF Test Case Descriptions` +* :ref:`VNF Provider Use Cases` +* :ref:`VNFRQTS Project Release Notes` diff --git a/docs/guides/onap-provider/vnfvalidator.rst b/docs/guides/onap-provider/vnfvalidator.rst index 9a80e3e25..854f06c44 100644 --- 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` - -:ref:`vvp documentation release-notes` +* :ref:`vvp documentation` +* :ref:`vvp documentation release-notes` -- 2.16.6