Cleanup naming convention for DMI-Plugin 96/124796/1
authorDylanB95EST <dylan.byrne@est.tech>
Mon, 11 Oct 2021 15:33:29 +0000 (16:33 +0100)
committerDylanB95EST <dylan.byrne@est.tech>
Mon, 11 Oct 2021 15:33:36 +0000 (16:33 +0100)
Cleanup naming conventions for DMI-Plugin project.

Issue-ID: CPS-627
Change-Id: I6ac542c983870f737760768363ef5764f792a5b7
Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
docs/architecture.rst
docs/deployment.rst
docs/design.rst
docs/modeling.rst
docs/overview.rst

index 65e10d4..069caa6 100644 (file)
@@ -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
index d843113..9c3da02 100644 (file)
@@ -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
index 708feeb..d0d4b87 100644 (file)
@@ -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>`
 
index fdfcef0..d4f6bbe 100644 (file)
@@ -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>`_.
index e8310ae..b32e102 100644 (file)
@@ -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
 -------------------