Merge branch '18363-managed-properties-doc-improvement' into main.
authorLucas Di Pentima <lucas.dipentima@curii.com>
Wed, 17 Nov 2021 18:28:37 +0000 (15:28 -0300)
committerLucas Di Pentima <lucas.dipentima@curii.com>
Wed, 17 Nov 2021 18:28:37 +0000 (15:28 -0300)
Closes #18363

Arvados-DCO-1.1-Signed-off-by: Lucas Di Pentima <lucas.dipentima@curii.com>

doc/admin/collection-managed-properties.html.textile.liquid

index 39520012639d9607b4314513378c4f0b45b061e7..341030c418d1e88030a36f6b7e422f760e5940f6 100644 (file)
@@ -41,13 +41,23 @@ h4. Protected properties
 
 If there's a need to prevent a non-admin user from modifying a specific property, even by its owner, the @Protected@ attribute can be set to @true@, like so:
 
+<pre>
+Collections:
+  ManagedProperties:
+    sample_id: {Protected: true}
+</pre>
+
+This configuration won't assign a @sample_id@ property on collection creation, but if the user adds it to any collection, its value is protected from that point on.
+
+Another use case would be to protect properties that were automatically assigned by the system:
+
 <pre>
 Collections:
   ManagedProperties:
     responsible_person_uuid: {Function: original_owner, Protected: true}
 </pre>
 
-This property can be applied to any of the defined managed properties. If missing, it's assumed as being @false@ by default.
+If missing, the @Protected@ attribute it’s assumed as being @false@ by default.
 
 h3. Supporting example scripts