Workflows: Document how to set which user group can review (#2483)

---------

Co-authored-by: Adrien Dupuis <[email protected]>
Co-authored-by: Tomasz Dąbrowski <[email protected]>

Author: 3 people

code_samples/workflow/custom_workflow/config/packages/workflows.yaml

@@ -30,6 +30,7 @@ ibexa:
                             icon: '/bundles/ibexaplatformicons/img/all-icons.svg#notice'
                             reviewers:
                                 required: true
+                                user_group: 13
                             actions:
                                 legal_transition_action:
                                     data:

docs/content_management/workflow/add_custom_workflow_action.md

@@ -16,8 +16,8 @@ The following example shows how to configure two custom actions that send custom
 
 Configure the first custom action under the `ibexa.system.<scope>.workflows` [configuration key](configuration.md#configuration-files):
 
-``` yaml hl_lines="15-18"
-[[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 0, 5) =]][[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 23, 36) =]]
+``` yaml hl_lines="16-19"
+[[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 0, 5) =]][[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 23, 37) =]]
 ```
 
 The configuration indicates the name of the custom action (`legal_transition_action`).
@@ -27,7 +27,7 @@ The configuration indicates the name of the custom action (`legal_transition_act
 
 To define what the action does, create an event listener `src/EventListener/LegalTransitionListener.php`:
 
-``` php hl_lines="27 36"
+``` php hl_lines="27 37"
 [[= include_file('code_samples/workflow/custom_workflow/src/EventListener/LegalTransitionListener.php') =]]
 ```
 
@@ -48,7 +48,7 @@ Line 36 in the listener above sets a custom result value for the transition.
 You can use this value in other stages and transitions for this content item, for example:
 
 ``` yaml hl_lines="10 11"
-[[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 42, 53) =]]
+[[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 43, 54) =]]
 ```
 
 The action indicated here is performed only if the result from the `legal_transition_action` is set to `true`.

docs/content_management/workflow/workflow.md

@@ -22,7 +22,7 @@ The following example configuration defines a workflow where you can optionally
 ![Diagram of custom workflow](workflow_custom_diagram.png)
 
 ``` yaml
-[[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 0, 32) =]][[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 37, 50) =]][[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 53, 61) =]]
+[[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 0, 33) =]][[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 38, 51) =]][[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 54, 62) =]]
 ```
 
 ### Matchers
@@ -61,13 +61,14 @@ A transition must state between which stages it transitions (lines 3-4),
 or be `reverse` to a different transition (line 9).
 
 ``` yaml hl_lines="3 4 9"
-[[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 23, 30) =]][[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 37, 42) =]]
+[[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 23, 30) =]][[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 38, 43) =]]
 ```
 
 ### Reviewers
 
 When moving a content item through a transition, the user can select a reviewer.
 Assigning a reviewer is mandatory if you set `reviewers.required` to `true` for this transition.
+You can restrict who can review the content item by setting `reviewers.user_group` to a Location ID of the user group.
 
 To be able to search for users for review, the user must have the content/read Policy without any Limitation,
 or with a Limitation that allows reading users.
@@ -107,7 +108,7 @@ You can automatically publish a content item once it goes through a specific tra
 To do so, configure the `publish` action for the transition:
 
 ``` yaml hl_lines="7 8"
-[[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 53, 61) =]]
+[[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 54, 62) =]]
 ```
 
 ### Disable Quick Review
@@ -116,7 +117,7 @@ You can disable the default workflow, for example, if your project does not use
 workflows, or Quick Review entries clog your database:
 
 ``` yaml
-[[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 0, 4) =]][[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 62, 66) =]]
+[[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 0, 4) =]][[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 63, 67) =]]
 ```
 
 ## Custom actions
@@ -181,8 +182,8 @@ To enable form validation in UI before sending it to the next stage of the workf
 add `validate: true` to the transitions of the stage.
 In the example below the form is validated in two stages:` to_legal` and `done`:
 
-``` yaml hl_lines="14 27"
-[[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 23, 42) =]][[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 54, 62) =]]
+``` yaml hl_lines="15 28"
+[[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 23, 43) =]][[= include_file('code_samples/workflow/custom_workflow/config/packages/workflows.yaml', 55, 63) =]]
 ```
 
 You can check validation for a particular stage of the workflow even if the stage doesn't have any actions.