diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin-guide.rst | 8 | ||||
| -rwxr-xr-x | docs/conf.py | 5 | ||||
| -rw-r--r-- | docs/deployment.rst | 3 | ||||
| -rwxr-xr-x | docs/index.rst | 2 | ||||
| -rw-r--r-- | docs/modeling.rst | 5 |
5 files changed, 17 insertions, 6 deletions
diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst index 3a6f8e2559..7689ee5b6d 100644 --- a/docs/admin-guide.rst +++ b/docs/admin-guide.rst @@ -12,6 +12,9 @@ CPS Admin Guide .. toctree:: :maxdepth: 1 +.. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning +.. _cps_common_logging: + Logging & Diagnostics ===================== @@ -44,6 +47,9 @@ Logger configuration is provided as a chart resource : | ncmp-dmi-plugin | Not yet applicable to DMI-Plugin | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +.. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning +.. _cps_common_monitoring: + Monitoring ========== Once CPS-Core is deployed, information related to the running instance of the application is available @@ -69,4 +75,4 @@ Prometheus Metrics can be checked at the following endpoint .. code:: - http://<cps-component-service-name>:8081/manage/prometheus
\ No newline at end of file + http://<cps-component-service-name>:8081/manage/prometheus diff --git a/docs/conf.py b/docs/conf.py index 3aaddd194f..84dac1ea21 100755 --- 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) +intersphinx_mapping['onap-cps-cps-temporal'] = ('{}/onap-cps-cps-temporal/en/%s'.format(doc_url) % branch, None) linkcheck_ignore = [ 'http://localhost', diff --git a/docs/deployment.rst b/docs/deployment.rst index 61f9ad2943..b1839cbb88 100644 --- a/docs/deployment.rst +++ b/docs/deployment.rst @@ -98,7 +98,8 @@ Each cps component can be restarted independently by issuing the following comma kubectl delete pod <cps-component-pod-name> -n <namespace> -.. _credentials_retrieval: +.. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning +.. _cps_common_credentials_retrieval: Credentials Retrieval --------------------- diff --git a/docs/index.rst b/docs/index.rst index b749604eeb..62ba5e8b17 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,7 +23,7 @@ CPS Documentation release-notes.rst DMI-Plugin Documentation ------------------------------ +------------------------ * :ref:`DMI-Plugin<onap-cps-ncmp-dmi-plugin:master_index>` diff --git a/docs/modeling.rst b/docs/modeling.rst index a91eb0178a..5504bf322e 100644 --- a/docs/modeling.rst +++ b/docs/modeling.rst @@ -56,6 +56,9 @@ Querying - **CPS Path** is used to query data nodes. The CPS Path is described in detail in :doc:`cps-path`. +.. 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: + NCMP Modeling ============= @@ -83,4 +86,4 @@ Basic Concepts | Passthrough-operational | config-true, config-false | read-only | +--------------------------------+-------------------------------------+-------------------------+ | Passthrough-running | config-true | read-write | - +--------------------------------+-------------------------------------+-------------------------+
\ No newline at end of file + +--------------------------------+-------------------------------------+-------------------------+ |