diff options
| author |   Niamh Core <niamh.core@est.tech> | 2021-10-21 11:36:35 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2021-10-21 11:36:35 +0000 |
| commit | 46e5b98302f3c909648a83d622d48ccd5d71595a (patch) | |
| tree | 87d3c7e2138a259457be503fd30f7547b751caac | |
| parent | c28a0a0c88681902e760b37f31483e56a98858c2 (diff) | |
| parent | 39207857709df915719f1f3e4dbe7f84b9ff825c (diff) | |
Merge "Prepare for links accross different name-spaces"
| -rw-r--r-- | docs/admin-guide.rst | 8 | ||||
| -rwxr-xr-x | docs/conf.py | 5 | ||||
| -rw-r--r-- | docs/deployment.rst | 3 |
3 files changed, 12 insertions, 4 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 --------------------- |