Use intersphinx links for easier release update

Alligned index page format and content with those for other CPS components

Issue-ID: CPS-721
Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
Change-Id: I81c88f75c2813e9034b6e9db31a70d9483b047b3

diff --git a/docs/conf.py b/docs/conf.py
index c2df42d..caaf753 100755 (executable)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -20,14 +20,15 @@
 from docutils.parsers.rst import directives
 from docs_conf.conf import *
 
+#change 'latest' to relevant branch-name once branch has been created
 branch = 'latest'
 doc_url = 'https://docs.onap.org/projects'
 master_doc = 'index'
 
 intersphinx_mapping = {}
 
-# Latest (change to branch)
 intersphinx_mapping['onap-cps'] = ('{}/onap-cps/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-cps-ncmp-dmi-plugin'] = ('{}/onap-cps-ncmp-dmi-plugin/en/%s'.format(doc_url) % branch, None)
 
 linkcheck_ignore = [
     'http://localhost',

diff --git a/docs/content/admin-guide.rst b/docs/content/admin-guide.rst
index 7415772..ebd9355 100644 (file)
--- a/docs/content/admin-guide.rst
+++ b/docs/content/admin-guide.rst
@@ -3,6 +3,7 @@
 .. http://creativecommons.org/licenses/by/4.0
 ..
 .. Copyright (C) 2021 Bell Canada
+.. Modifications Copyright (C) 2021 Nordix Foundation
 
 ========================
 CPS Temporal Admin Guide
@@ -20,7 +21,7 @@ Refer to :doc:`deployment` for application properties available to configure the
 Logging
 =======
 
-Refer to `CPS Admin Guide <https://docs.onap.org/projects/onap-cps/en/latest/admin-guide.html>`_
+Refer to :ref:`CPS Logging<onap-cps:cps_common_logging>`
 for documentation related to CPS Temporal and all CPS components
 logging information.
 
@@ -28,6 +29,6 @@ logging information.
 Monitoring
 ==========
 
-Refer to `CPS Admin Guide <https://docs.onap.org/projects/onap-cps/en/latest/admin-guide.html>`_
+Refer to :ref:`CPS Monitoring<onap-cps:cps_common_monitoring>`
 page for documentation related to CPS Temporal and all CPS components
 monitoring information.

diff --git a/docs/content/deployment.rst b/docs/content/deployment.rst
index da5a6d2..fd6fd59 100644 (file)
--- a/docs/content/deployment.rst
+++ b/docs/content/deployment.rst
@@ -3,6 +3,7 @@
 .. http://creativecommons.org/licenses/by/4.0
 ..
 .. Copyright (C) 2021 Bell Canada
+.. Modifications Copyright (C) 2021 Nordix Foundation
 
 =======================
 CPS Temporal Deployment
@@ -15,9 +16,8 @@ CPS Temporal Deployment
 Deployment
 ==========
 
-Refer to `CPS Deployment <https://docs.onap.org/projects/onap-cps/en/latest/deployment.html>`_
-page for documentation related to CPS Temporal and all CPS components
-deployment.
+Refer to :ref:`CPS-Deployment<onap-cps:deployment>`
+page for deployment documentation related to CPS Temporal and all CPS components.
 
 Once CPS Temporal is successfully deployed and running 2 pods are started,
 one for running the service and another one for running the database instance:
@@ -46,12 +46,9 @@ exhaustive.
 |                                       | This is the user name to be used by CPS Temporal REST clients to authenticate themselves.               |                               |
 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 | config.appUserPassword                | Password used by CPS Temporal service to configure the authentication for REST API it exposes.          | Not defined                   |
-|                                       |                                                                                                         |                               |
 |                                       | This is the password to be used by CPS Temporal REST clients to authenticate themselves.                |                               |
-|                                       |                                                                                                         |                               |
 |                                       | If not defined, the password is generated when deploying the application.                               |                               |
-|                                       |                                                                                                         |                               |
-|                                       | See also :ref:`credentials` section.                                                                    |                               |
+|                                       | See also :ref:`CPS Credentials Retrieval<onap-cps:cps_common_credentials_retrieval>`                    |                               |
 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 | timescaledb.config.pgUserName         | Internal user name used bt CPS Temporal to connect to its own database.                                 | ``cpstemporal``               |
 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
@@ -120,9 +117,8 @@ exhaustive.
 Credentials
 -----------
 
-Once the deployment is completed, refer to Credentials Retrieval section in
-`CPS Deployment <https://docs.onap.org/projects/onap-cps/en/latest/deployment.html>`_
-page for more information related to credentials retrieval.
+Once the deployment is completed, refer to :ref:`CPS Credentials Retrieval<onap-cps:cps_common_credentials_retrieval>`
+ for more information related to credentials retrieval.
 
 Running With Docker
 ===================

diff --git a/docs/index.rst b/docs/index.rst
index ebaad15..0ff3359 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,12 +3,13 @@
 .. http://creativecommons.org/licenses/by/4.0
 ..
 .. Copyright (C) 2021 Bell Canada
+.. Modifications Copyright (C) 2021 Nordix Foundation
 
 .. _master_index:
 
-============
-CPS Temporal
-============
+
+CPS Temporal Documentation
+--------------------------
 
 .. toctree::
    :maxdepth: 1
@@ -20,3 +21,13 @@ CPS Temporal
    content/deployment.rst
    content/admin-guide.rst
    content/release-notes.rst
+
+CPS-NCMP Documentation
+----------------------
+
+* :ref:`CPS-NCMP<onap-cps:master_index>`
+
+DMI-Plugin Documentation
+-----------------------------
+
+* :ref:`DMI-Plugin<onap-cps-ncmp-dmi-plugin:master_index>`