State Model RTD

Add Read The Doc documentation for CM-Handle state model
Briefly explain all 5 potnetial cm handle states

Issue-ID: CPS-1162
Change-Id: Iee52f9c280929337abf4aac2f5c9bbfb1edde30f
Signed-off-by: DylanB95EST <dylan.byrne@est.tech>

diff --git a/docs/modeling.rst b/docs/modeling.rst
index 80cfdea..7cc2c4c 100644 (file)
--- a/docs/modeling.rst
+++ b/docs/modeling.rst
@@ -83,6 +83,20 @@ Basic Concepts
 
     These are stored as Anchors within CPS-Core.
 
+    - **CM-Handle States** are used to represent the potential states in which a CM-Handle can transition between.
+
+        The 5 possible CM-Handle states are: ADVISED, READY, LOCKED, DELETING, DELETED
+
+        **ADVISED** indicates that a CM-Handle has been registered successfully, and is waiting for the module synchronization process to sync the CM-Handle.
+
+        **READY** indicates that the CM-Handle has been synced successfully.
+
+        **LOCKED** indicates that the CM-Handle has not synced successfully. A retry mechanism within CPS will set the state back to ADVISED after a set time.
+
+        **DELETING** indicates that the CM-Handle is currently being deleted.
+
+        **DELETED** indicates that the CM-Handle has been deleted successfully.
+
     - **Data-sync state** is the state of the data synchronization process of the CM-Handle
 
         There are 3 possibles states: NONE_REQUESTED, UNSYNCHRONIZED, SYNCHRONIZED