diff options
| author |   lukegleeson <luke.gleeson@est.tech> | 2021-11-08 15:53:12 +0000 |
|---|---|---|
| committer | lukegleeson <luke.gleeson@est.tech> | 2021-11-08 17:00:21 +0000 |
| commit | f027cfba276b5b56b06fe7deb9f629fd8be7d911 (patch) | |
| tree | 0f1e021aaeeb3a3c96e459839ef322873ae95085 | |
| parent | b6fe4eb602206e5495423ff8614eb5238829d115 (diff) | |
Improve internal documentation links
Issue-ID: CPS-749
Signed-off-by: lukegleeson <luke.gleeson@est.tech>
Change-Id: I449d14cfb6b5463394a80a8ef23180dd31a1ad50
| -rw-r--r-- | docs/deployment.rst | 6 | ||||
| -rwxr-xr-x | docs/design.rst | 2 | ||||
| -rw-r--r-- | docs/modeling.rst | 6 |
3 files changed, 9 insertions, 5 deletions
diff --git a/docs/deployment.rst b/docs/deployment.rst index b1839cbb88..2f68a64ee1 100644 --- a/docs/deployment.rst +++ b/docs/deployment.rst @@ -177,7 +177,7 @@ exhaustive. | | | | | | If not defined, the password is generated when deploying the application. | | | | | | -| | See also :ref:`credentials_retrieval`. | | +| | See also :ref:`cps_common_credentials_retrieval`. | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | config.dmiPluginUserName | User name used by cps-core to authenticate themselves for using ncmp-dmi-plugin service. | ``dmiuser`` | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ @@ -185,7 +185,7 @@ exhaustive. | | | | | | If not defined, the password is generated when deploying the application. | | | | | | -| | See also :ref:`credentials_retrieval`. | | +| | See also :ref:`cps_common_credentials_retrieval`. | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | postgres.config.pgUserName | Internal user name used by cps-core to connect to its own database. | ``cps`` | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ @@ -193,7 +193,7 @@ exhaustive. | | | | | | If not defined, the password is generated when deploying the application. | | | | | | -| | See also :ref:`credentials_retrieval`. | | +| | See also :ref:`cps_common_credentials_retrieval`. | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | postgres.config.pgDatabase | Database name used by cps-core | ``cpsdb`` | | | | | diff --git a/docs/design.rst b/docs/design.rst index 02836c5f37..eb5f6b6e07 100755 --- a/docs/design.rst +++ b/docs/design.rst @@ -64,7 +64,7 @@ CPS Core uses API's from the following ONAP components * DMI-Plugin: REST based interface which is used to provide integration and allow the DMI registry API's have access to the corresponding NCMP API's within CPS Core. - More information on the DMI-Plugins offered APIs can be found on the `DMI-Plugin's Design Page <https://docs.onap.org/projects/onap-cps-ncmp-dmi-plugin/en/latest/design.html>`_. + More information on the DMI-Plugins offered APIs can be found on the :ref:`DMI-Plugin's Design Page <onap-cps-ncmp-dmi-plugin:design>`. CPS Path ======== diff --git a/docs/modeling.rst b/docs/modeling.rst index 5504bf322e..b750c6d5b3 100644 --- a/docs/modeling.rst +++ b/docs/modeling.rst @@ -54,7 +54,11 @@ Data Querying -- **CPS Path** is used to query data nodes. The CPS Path is described in detail in :doc:`cps-path`. +- **CPS Path** is used to query data nodes. +.. toctree:: + :maxdepth: 1 + + cps-path.rst .. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning .. _cps_ncmp_modelling: |