From 39207857709df915719f1f3e4dbe7f84b9ff825c Mon Sep 17 00:00:00 2001 From: ToineSiebelink Date: Thu, 21 Oct 2021 12:11:25 +0100 Subject: [PATCH] Prepare for links accross different name-spaces -add intersphinx mapping -add labels for re-use in other CPS components Issue-ID: CPS-721 Signed-off-by: ToineSiebelink Change-Id: Ib45716e75f85bd3ba28295ffe79db95e3575daaa --- docs/admin-guide.rst | 8 +++++++- docs/conf.py | 5 +++-- docs/deployment.rst | 3 ++- 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst index 3a6f8e255..7689ee5b6 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://:8081/manage/prometheus \ No newline at end of file + http://:8081/manage/prometheus diff --git a/docs/conf.py b/docs/conf.py index 3aaddd194..84dac1ea2 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 61f9ad294..b1839cbb8 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 -n -.. _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 --------------------- -- 2.16.6