Cleanup naming conventions for DMI-Plugin project.
Issue-ID: CPS-627
Change-Id: I6ac542c983870f737760768363ef5764f792a5b7
Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
.. Copyright (C) 2021 Nordix Foundation
.. _architecture:
-DMI Plugin Architecture
+DMI-Plugin Architecture
#######################
.. toctree::
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
- Query module references
- REST
* - CPS-NCMP-I-01
- - DMI Plugin Inventory
+ - DMI-Plugin Inventory
- - Register Plug-in CM-Handles
- REST
* - DMI-I-01
- 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
.. _deployment:
-DMI Plugin Deployment
+DMI-Plugin Deployment
#####################
.. toctree::
==========
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
| 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
.. _design:
-DMI Plugin Design
+DMI-Plugin Design
#################
.. toctree::
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>`
.. 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>`_.
.. 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
-------------------