diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/architecture.rst | 10 | ||||
| -rw-r--r-- | docs/deployment.rst | 8 | ||||
| -rw-r--r-- | docs/design.rst | 4 | ||||
| -rw-r--r-- | docs/modeling.rst | 6 | ||||
| -rw-r--r-- | docs/overview.rst | 4 |
5 files changed, 16 insertions, 16 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst index 65e10d45..069caa6f 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -3,7 +3,7 @@ .. Copyright (C) 2021 Nordix Foundation .. _architecture: -DMI Plugin Architecture +DMI-Plugin Architecture ####################### .. toctree:: @@ -13,14 +13,14 @@ DMI Plugin Architecture High Level Component Definition and Architectural Relationships =============================================================== -The DMI plugin provides a gateway for registration and syncing of CM Handles within CPS. +The DMI-Plugin provides a gateway for registration and syncing of CM Handles within CPS. .. image:: _static/cps-r9-ncmp-dmi-plugin-interface-diagram.png API definitions =============== -The DMI plugin provides following interfaces. +The DMI-Plugin provides following interfaces. .. list-table:: :header-rows: 1 @@ -39,7 +39,7 @@ The DMI plugin provides following interfaces. - Query module references - REST * - CPS-NCMP-I-01 - - DMI Plugin Inventory + - DMI-Plugin Inventory - - Register Plug-in CM-Handles - REST * - DMI-I-01 @@ -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 `CPS Architecture Page <https://docs.onap.org/projects/onap-cps/en/latest/architecture.html>`_.
\ No newline at end of file diff --git a/docs/deployment.rst b/docs/deployment.rst index d8431139..9c3da025 100644 --- a/docs/deployment.rst +++ b/docs/deployment.rst @@ -6,7 +6,7 @@ .. _deployment: -DMI Plugin Deployment +DMI-Plugin Deployment ##################### .. toctree:: @@ -16,9 +16,9 @@ Deployment ========== Refer to `CPS Deployment <https://docs.onap.org/projects/onap-cps/en/latest/deployment.html>`_ -page for deployment documentation related to DMI Plugin and all CPS components. +page for deployment documentation related to DMI-Plugin and all CPS components. -Additional DMI Plugin Core Customisations +Additional DMI-Plugin Core Customisations ========================================= Application Properties @@ -51,7 +51,7 @@ values to configure for the application being deployed. This list is not exhaust | config.sdnc.topologyId | SDNC topology Id. | ``topology-netconf`` | +---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+ -DMI Plugin Docker Installation +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 diff --git a/docs/design.rst b/docs/design.rst index 708feeb3..d0d4b87f 100644 --- a/docs/design.rst +++ b/docs/design.rst @@ -6,7 +6,7 @@ .. _design: -DMI Plugin Design +DMI-Plugin Design ################# .. toctree:: @@ -15,7 +15,7 @@ DMI Plugin Design Offered APIs ============ -The DMI Plugin supports the public APIs listed in the link below: +The DMI-Plugin supports the public APIs listed in the link below: :download:`DMI Rest OpenApi Specification <openapi/openapi.yaml>` diff --git a/docs/modeling.rst b/docs/modeling.rst index fdfcef06..d4f6bbed 100644 --- a/docs/modeling.rst +++ b/docs/modeling.rst @@ -3,12 +3,12 @@ .. Copyright (C) 2021 Nordix Foundation .. _modeling: -DMI Plugin Modeling +DMI-Plugin Modeling ################### .. toctree:: :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>`_ +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>`_. diff --git a/docs/overview.rst b/docs/overview.rst index e8310ae4..b32e1025 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -3,10 +3,10 @@ .. Copyright (C) 2021 Nordix Foundation .. _overview: -DMI Plugin Overview +DMI-Plugin Overview =================== -The DMI Plugin is used to allow the DMI API's access to the corresponding NCMP API's. For offered API's please refer to the :doc:`design` page. +The DMI-Plugin is used to allow the DMI API's access to the corresponding NCMP API's. For offered API's please refer to the :doc:`design` page. Contact Information ------------------- |