SYN-6658: docs on ext props updated to note the need to delete values before removing them (#3510)

MichaelSquires · web-flow · commit 43fb57267a62 · 2024-01-26T09:13:16.000-05:00
docs: Update admin guide with additional info about updating extended
model elements.
diff --git a/docs/synapse/adminguide.rstorm b/docs/synapse/adminguide.rstorm
@@ -1385,6 +1385,13 @@ The Synapse data model in a Cortex can be extended with custom `forms`_ or `prop
 extension Storm Library (:ref:`stormlibs-lib-model-ext`). Extended model forms and properties must have names
 beginning with an underscore (``_``) to avoid potential naming conflicts with built-in model elements.
 
+.. NOTE::
+
+  Extended model elements that are in-use (have nodes using the extended forms or properties) cannot be removed until
+  all instances of that extended model element are removed. In other words, before removing extended forms any nodes
+  created with that extended form must be delete first, and before removing extended properties any nodes with that
+  extended property must have the property value removed.
+
 Extended Forms
 --------------
 
