Cleanup naming conventions for CPS-NCMP 95/124795/2
authorDylanB95EST <dylan.byrne@est.tech>
Mon, 11 Oct 2021 15:29:16 +0000 (16:29 +0100)
committerDylanB95EST <dylan.byrne@est.tech>
Mon, 11 Oct 2021 15:41:53 +0000 (16:41 +0100)
Change naming conventions in CPS-NCMP project

Issue-ID: CPS-626
Change-Id: Ie97c53ef50eb3d0947136db0606047150181ec1b
Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
docs/admin-guide.rst
docs/architecture.rst
docs/design.rst
docs/index.rst
docs/modeling.rst
docs/overview.rst
docs/release-notes.rst

index fab8d54..3a6f8e2 100644 (file)
@@ -41,7 +41,7 @@ Logger configuration is provided as a chart resource :
     +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
     | cps-temporal                   | `logback.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-temporal/resources/config/logback.xml>`_    |
     +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-    | ncmp-dmi-plugin                | Not yet applicable to DMI Plugin                                                                                                |
+    | ncmp-dmi-plugin                | Not yet applicable to DMI-Plugin                                                                                                |
     +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
 
 Monitoring
index 12a51e2..26a8c63 100644 (file)
@@ -16,7 +16,7 @@ High Level Component Definition and Architectural Relationships
 The Configuration Persistence Service (CPS) provides storage for run-time configuration and operational
 parameters that need to be used by ONAP.
 
-In this release CPS is no longer a stand alone component and is released along with Cps-Temporal and the NCMP-DMI Plugin.
+In this release CPS is no longer a stand alone component and is released along with Cps-Temporal and the NCMP-DMI-Plugin.
 
 Project page describing eventual scope and ambition is here:
 `Configuration Persistence Service Project <https://wiki.onap.org/display/DW/Configuration+Persistence+Service+Project>`_
index ce419ca..7df24ec 100755 (executable)
@@ -47,7 +47,7 @@ CPS Core uses API's from the following ONAP components
 
 * DMI-Plugin: REST based interface which is used to provide integration
   and allow the DMI registry API's have access to the corresponding NCMP API's within CPS Core.
-  More information on the DMI Plugins offered APIs can be found on the `DMI Plugin's Design Page <https://docs.onap.org/projects/onap-cps-ncmp-dmi-plugin/en/latest/design.html>`_.
+  More information on the DMI-Plugins offered APIs can be found on the `DMI-Plugin's Design Page <https://docs.onap.org/projects/onap-cps-ncmp-dmi-plugin/en/latest/design.html>`_.
 
 CPS Path
 ========
index 0ecfab3..cbe1b69 100755 (executable)
@@ -9,7 +9,7 @@
 .. _cps-framework-doc:
 
 CPS Documentation
-----------------------
+-----------------
 
 .. toctree::
    :maxdepth: 1
@@ -22,12 +22,12 @@ CPS Documentation
    deployment.rst
    release-notes.rst
 
-ONAP DMI Plugin Documentation
+DMI-Plugin Documentation
 -----------------------------
 
-* `DMI Plugin <https://docs.onap.org/projects/onap-cps-ncmp-dmi-plugin/en/latest/index.html>`_
+* `DMI-Plugin <https://docs.onap.org/projects/onap-cps-ncmp-dmi-plugin/en/latest/index.html>`_
 
 CPS-Temporal Documentation
 --------------------------
 
-* `CPS Temporal <https://docs.onap.org/projects/onap-cps-cps-temporal/en/latest/index.html>`_
+* `CPS-Temporal <https://docs.onap.org/projects/onap-cps-cps-temporal/en/latest/index.html>`_
index 863e932..a91eb01 100644 (file)
@@ -62,7 +62,7 @@ NCMP Modeling
 Data Model
 ----------
 
-NCMP stores DMI Plugin and CM Handle relations using a data model described as per this Yang module.
+NCMP stores DMI-Plugin and CM Handle relations using a data model described as per this Yang module.
 
 :download:`DMI Yang Module <api/yang/dmiYangResource.yang>`
 
index 1333e66..4b69dd8 100644 (file)
@@ -37,18 +37,18 @@ This is the component of CPS which encompasses the generic storage of Yang modul
 **NCMP**
 
 The Network Configuration Management Proxy (NCMP) provides access to network configuration data and is a part of CPS-Core.
-NCMP accesses all network Data-Model-Inventory (DMI) information via NCMP-DMI-Plugins. The ONAP DMI Plugin described in the next section is one such plugin.
+NCMP accesses all network Data-Model-Inventory (DMI) information via NCMP-DMI-Plugins. The ONAP0-DMI-Plugin described in the next section is one such plugin.
 
 **Note:** This documentation will often refer to "CPS-NCMP" which is the component (container image) that contains both CPS-Core and NCMP since NCMP is not a stand-alone component
 even though CPS-Core could be deployed without the NCMP extension.
 
-ONAP NCMP-DMI-Plugin
+NCMP-DMI-Plugin
 ####################
 
-The Data-Model-Inventory (DMI) Plugin is a rest interface used to synchronize CM-Handles data between CPS and DMI through the DMI Plugin.
+The Data-Model-Inventory (DMI) Plugin is a rest interface used to synchronize CM-Handles data between CPS and DMI through the DMI-Plugin.
 This is built previously from the CPS-NF-Proxy component.
 
-CPS Temporal
+CPS-Temporal
 ############
 
 This service is responsible to provide a time oriented perspective for
index fc672c4..6e5d917 100755 (executable)
@@ -100,7 +100,7 @@ Release Data
 
 Features
 --------
-* Register DMI Plugins with NCMP for CM Handle registrations.
+* Register DMI-Plugins with NCMP for CM Handle registrations.
 * Update, Create and Remove CM Handles.
 * Add support for retrieving and writing CM Handle data through NCMP datastores.
 * Automatic retrieval and caching of model information for CM Handles within NCMP.
@@ -160,9 +160,9 @@ Following CPS components are available with default ONAP/CPS installation.
 
     * Service components
 
-        - CPS Core and NCMP
-        - CPS Temporal
-        - DMI Plugin
+        - CPS-NCMP
+        - CPS-Temporal
+        - DMI-Plugin
 
     * Additional resources that CPS utilizes deployed using ONAP common charts