diff options
| -rw-r--r-- | docs/admin-guide.rst | 2 | ||||
| -rw-r--r-- | docs/architecture.rst | 2 | ||||
| -rw-r--r-- | docs/conf.py | 3 | ||||
| -rw-r--r-- | docs/deployment.rst | 6 | ||||
| -rw-r--r-- | docs/index.rst | 16 | ||||
| -rw-r--r-- | docs/modeling.rst | 3 |
6 files changed, 16 insertions, 16 deletions
diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst index 787e931b..a1af64aa 100644 --- a/docs/admin-guide.rst +++ b/docs/admin-guide.rst @@ -9,4 +9,4 @@ DMI-Plugin Admin Guide ###################### -For DMI-Plugin Admin Guide, please refer to the `CPS Admin Guide. <https://docs.onap.org/projects/onap-cps/en/latest/admin-guide.html>`_
\ No newline at end of file +Please refer to the common :ref:`CPS Admin Guide<onap-cps:adminGuide>` diff --git a/docs/architecture.rst b/docs/architecture.rst index 069caa6f..a7bc974d 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -52,4 +52,4 @@ The DMI-Plugin provides following interfaces. - Query module references - REST -More details on the CPS interface CPS-E-05 which is responsible for the DMI-Plugin can be found on the `CPS Architecture Page <https://docs.onap.org/projects/onap-cps/en/latest/architecture.html>`_.
\ No newline at end of file +More details on the CPS interface CPS-E-05 which is responsible for the DMI-Plugin can be found on the :ref:`CPS Architecture page<onap-cps:architecture>` diff --git a/docs/conf.py b/docs/conf.py index 3aaddd19..723fb21f 100644 --- 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-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 9c3da025..0d7b1031 100644 --- a/docs/deployment.rst +++ b/docs/deployment.rst @@ -15,7 +15,7 @@ DMI-Plugin Deployment Deployment ========== -Refer to `CPS Deployment <https://docs.onap.org/projects/onap-cps/en/latest/deployment.html>`_ +Refer to :ref:`CPS-Deployment<onap-cps:deployment>` page for deployment documentation related to DMI-Plugin and all CPS components. Additional DMI-Plugin Core Customisations @@ -34,7 +34,7 @@ values to configure for the application being deployed. This list is not exhaust +---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | config.appUserPassword | Password used by the DMI-Plugin to authenticate users for the REST APIs that it exposes. | Not defined | | | If not defined, the password is generated when deploying the application. | | -| | See also `Credentials Retrieval <https://docs.onap.org/projects/onap-cps/en/latest/deployment.html>`_ | | +| | See also :ref:`CPS Credentials Retrieval<onap-cps:cps_common_credentials_retrieval>` | | +---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | config.dmiServiceName | DMI-Plugin hostname and port. | Not defined | +---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+ @@ -56,4 +56,4 @@ DMI-Plugin Docker Installation DMI-Plugin can also be installed in a docker environment. Latest `docker-compose <https://github.com/onap/cps-ncmp-dmi-plugin/blob/master/docker-compose/docker-compose.yml>`_ is included in the repo to start all the relevant services. -Latest instructions are covered in the `README <https://github.com/onap/cps-ncmp-dmi-plugin/blob/master/docker-compose/README.md>`_
\ No newline at end of file +Latest instructions are covered in the `README <https://github.com/onap/cps-ncmp-dmi-plugin/blob/master/docker-compose/README.md>`_ diff --git a/docs/index.rst b/docs/index.rst index 7d1fcf37..236b1c8e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,8 +8,8 @@ .. THIS IS USED INTERNALLY IN CPS ONLY .. _dmi-framework-doc: -DMI-Plugin Documentation for the Istanbul-R9 Release ----------------------------------------------------- +DMI-Plugin Documentation +------------------------ .. toctree:: :maxdepth: 1 @@ -23,12 +23,12 @@ DMI-Plugin Documentation for the Istanbul-R9 Release release-notes.rst -CPS-NCMP Documentation for the Istanbul-R9 Release ---------------------------------------------------------- +CPS-NCMP Documentation +---------------------- -* `CPS-NCMP <https://docs.onap.org/projects/onap-cps/en/latest/index.html>`_ +* :ref:`CPS-NCMP<onap-cps:master_index>` -CPS-Temporal Documentation for the Istanbul-R9 Release ------------------------------------------------------- +CPS-Temporal Documentation +-------------------------- -* `CPS-Temporal <https://docs.onap.org/projects/onap-cps-cps-temporal/en/latest/index.html>`_ +* :ref:`CPS-Temporal<onap-cps-cps-temporal:master_index>` diff --git a/docs/modeling.rst b/docs/modeling.rst index d4f6bbed..f67b8a41 100644 --- a/docs/modeling.rst +++ b/docs/modeling.rst @@ -10,5 +10,4 @@ DMI-Plugin Modeling :maxdepth: 1 The DMI-Plugin acts as a proxy and as such does not have its own data model. For more information on the data which -is passed through the DMI-Plugin, please refer to the `NCMP Modeling Section <https://docs.onap.org/projects/onap-cps/en/latest/modeling.html#ncmp-modeling>`_ -of the `CPS Modeling Page <https://docs.onap.org/projects/onap-cps/en/latest/modeling.html>`_. +is passed through the DMI-Plugin, please refer to :ref:`NCMP Modeling<onap-cps:ncmp-modelling>`. |