Add docs about being able to set refs in delete steps

ezecosystem · Apr 3, 2018 · d7270bb · d7270bb
1 parent ba3b590
commit d7270bb
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 4 deletions.
diff --git a/Resources/doc/DSL/ContentTypeGroups.yml b/Resources/doc/DSL/ContentTypeGroups.yml
@@ -59,3 +59,4 @@
                 _condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
         not: # matches elements NOT satisfying the wrapped condition
             _condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
+    references: # Optional. See above for allowed values
diff --git a/Resources/doc/DSL/ContentTypes.yml b/Resources/doc/DSL/ContentTypes.yml
@@ -108,8 +108,8 @@
     url_name_pattern: pattern # Optional
     default_sort_field: x # Optional. See ManageLocation.yml for details
     default_sort_order: ASC|DESC # Optional
-    # The list in references tells the manager to store specific values for later use by other steps in the current
-    # migration.
+    # The list in references tells the manager to store specific values for later use by other steps in the current migration.
+    # NB: these are NEW VARIABLES THAT YOU ARE CREATING. They are not used in the current migration step!
     references: # Optional
         -
             identifier: referenceId # A string used to identify the reference
@@ -208,6 +208,7 @@
                 _condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
         not: # matches elements NOT satisfying the wrapped condition
             _condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
+    references: # Optional. See above for allowed values
 
 # Attribute examples.
 

diff --git a/Resources/doc/DSL/ContentVersions.yml b/Resources/doc/DSL/ContentVersions.yml
@@ -4,3 +4,4 @@
     match: # Same as for Content update/delete/load actions
     versions: xxx # If an integer or array of integers: remove those specific versions
                   # If a negative integer -X: remove *all* versions except the last X (ie: -1 = leave only the last version)
+    references: # Optional. See Contents.yml for allowed values
diff --git a/Resources/doc/DSL/Contents.yml b/Resources/doc/DSL/Contents.yml
@@ -210,6 +210,7 @@
                 _condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
         not: # matches elements NOT satisfying the wrapped condition
             _condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
+    references: # Optional. See above for allowed values
 
 -
     type: content

diff --git a/Resources/doc/DSL/ObjectStatesAndGoups.yml b/Resources/doc/DSL/ObjectStatesAndGoups.yml
@@ -73,6 +73,7 @@
                 _condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
         not: # matches elements NOT satisfying the wrapped condition
             _condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
+    references: # Optional. See above for allowed values
 
 -
     mode: create
@@ -149,3 +150,4 @@
                 _condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
         not: # matches elements NOT satisfying the wrapped condition
             _condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
+    references: # Optional. See above for allowed values
diff --git a/Resources/doc/DSL/RolesAndPolicies.yml b/Resources/doc/DSL/RolesAndPolicies.yml
@@ -157,3 +157,4 @@
                 _condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
         not: # matches elements NOT satisfying the wrapped condition
             _condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
+    references: # Optional. See above for allowed values
diff --git a/Resources/doc/DSL/Sections.yml b/Resources/doc/DSL/Sections.yml
@@ -3,8 +3,8 @@
     mode: create
     name: xyz
     identifier: xyz
-    # The list in references tells the manager to store specific values for later use
-    # by other steps in the current migration.
+    # The list in references tells the manager to store specific values for later use by other steps in the current migration.
+    # NB: these are NEW VARIABLES THAT YOU ARE CREATING. They are not used in the current migration step!
     references: # Optional
          -
             identifier: referenceId # A string used to identify the reference
@@ -62,3 +62,4 @@
                 _condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
         not: # matches elements NOT satisfying the wrapped condition
             _condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
+    references: # Optional. See above for allowed values