Skip to content

Commit dc129fb

Browse files
authored
Feat: Update review-workflows documentation to include multipe workflows (#1784)
1 parent aa2dc08 commit dc129fb

File tree

10 files changed

+51
-20
lines changed

10 files changed

+51
-20
lines changed

docusaurus/docs/user-docs/settings/review-workflows.md

Lines changed: 50 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,45 +9,76 @@ description: Managing your review workflows and stages in Strapi.
99
Review Workflows is an <EnterpriseBadge />-only feature.
1010
:::
1111

12-
The Review Workflows feature allows you to create and manage any desired review stages for your content, enabling your team to collaborate in the content creation flow from draft to publication. Before being available in the [Content Manager](/user-docs/content-manager/reviewing-content) and [Content-Types Builder](/user-docs/content-type-builder), review workflows should be configured from ![Settings icon](/img/assets/icons/settings.svg) *Settings > Global settings > Review Workflows*.
12+
The Review Workflows feature allows you to create and manage workflows for your various content-types. Each workflow can consist of any review stages for your content, enabling your team to collaborate in the content creation flow from draft to publication.
1313

14-
:::note
15-
- The Review workflows settings are only available to users with the Super Admin role by default. Other roles must be granted the **Review workflows** permission. See [Users, Roles, & Permissions](/user-docs/users-roles-permissions) for more information.
16-
- Review Workflows are only available with the Enterprise Edition. If for any reason your project was downgraded to the Community Edition, all review workflows data would not be deleted but kept until the project goes back to Enterprise.
17-
:::
14+
<ThemedImage
15+
alt="Workflow list view"
16+
sources={{
17+
light: '/img/assets/review-workflows/list-view-light.png',
18+
dark: '/img/assets/review-workflows/list-view-dark.png',
19+
}}
20+
/>
21+
22+
In many organizations different teams review different parts of content. By using different review workflows for different content-types, it is possible to adjust each workflow to the needs of each team involved.
23+
24+
The default workflow is configured to have 4 stages: To do, In progress, Ready to review, and Reviewed. All 4 stages can be edited, reordered or deleted as needed, and it is also possible to add new stages.
25+
26+
Before being available in the [Content Manager](/user-docs/content-manager/reviewing-content), review workflows must be configured from ![Settings icon](/img/assets/icons/settings.svg) *Settings > Global settings > Review Workflows*. The Review workflows settings are only available to users with the Super Admin role by default. Other roles must be granted the **Review workflows** permissions. See [Users, Roles, & Permissions](/user-docs/users-roles-permissions) for more information.
27+
28+
29+
## Creating or editing a workflow
1830

1931
<ThemedImage
20-
alt="Review Workflows Settings"
32+
alt="Workflow edit view"
2133
sources={{
22-
light: '/img/assets/review-workflows/review-workflows.png',
23-
dark: '/img/assets/review-workflows/review-workflows_DARK.png',
34+
light: '/img/assets/review-workflows/edit-view-light.png',
35+
dark: '/img/assets/review-workflows/edit-view-dark.png',
2436
}}
2537
/>
2638

27-
There are 4 stages in the default review workflow available in Strapi: To do, In progress, Ready to review, and Reviewed. All 4 stages can be edited, reordered or deleted as needed, and it is also possible to add new stages.
39+
1. Click on the **Create new workflow** button or on the edit button ![Edit icon](/img/assets/icons/edit.svg) of a workflow.
40+
2. In the workflow edit interface, configure the new workflow:
2841

29-
## Adding a new stage
42+
| Setting name | Instructions |
43+
| -------------- | ------------------------------------------------------------------------ |
44+
| Name | Write a unique name of workflow. |
45+
| Content-Types | (optional) Assign this workflow to one or more existing content-types. |
46+
| Stages | Add review stages (see [Adding a new stage](#adding-a-new-stage)). |
47+
48+
3. Click on the **Save** button. The new workflow will be displayed in the list-view and for every content-type assigned.
49+
50+
:::note
51+
The maximum number of [workflows and stages per workflow is limited](https://strapi.io/pricing-cloud).
52+
:::
53+
54+
55+
### Adding a new stage
3056

3157
To add a new stage in the review workflows:
3258

3359
1. Click on the **Add new stage** button.
3460
2. Write the *Stage name*.
35-
3. Select a *Color*
61+
3. Select a *Color*.
3662
3. Click on the **Save** button.
3763

38-
:::tip
3964
By default new stages are appended, but they can be reordered anytime using the ![drag & drop](/img/assets/icons/drag.svg) button.
40-
:::
4165

42-
## Deleting a stage
4366

44-
:::warning Pending reviews on deleted stages
45-
If you delete a stage that has pending reviews, the reviews will be moved to first stage in the workflow.
46-
:::
47-
48-
To delete a stage from the review workflows:
67+
### Deleting a stage
4968

5069
1. Click on the ![delete button](/img/assets/icons/delete.svg) **Delete** button next to the stage you want to remove.
5170
2. Click on the **Save** button: a confirmation modal will appear to confirm the deletion.
5271

72+
If you delete a stage that has pending reviews, the reviews will be moved to first stage in the workflow. Every workflow needs to
73+
contain at least one stage and therefore it is not possible to delete the last stage.
74+
75+
76+
## Deleting a workflow
77+
78+
To delete a workflow click on the delete button ![Delete icon](/img/assets/icons/delete.svg) of a workflow in the list view.
79+
80+
:::note
81+
It is not possible to delete the last workflow.
82+
:::
83+
5384
<FeedbackPlaceholder />

docusaurus/docs/user-docs/users-roles-permissions/configuring-administrator-roles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ Settings permissions can be configured for all settings accessible from *General
139139
| Plugins and Marketplace | <ul><li>Marketplace</li><ul><li>"Access the Marketplace" - gives access to the Marketplace</li></ul></ul><ul><li>Plugins</li><ul><li>"Install (only for dev env)" - allows to install new plugins when in a development environment</li><li>"Uninstall (only for dev env)" - allows to uninstall plugins when in a development environment</li></ul></ul> |
140140
| Webhooks | <ul><li>General</li><ul><li>"Create" - allows to create webhooks</li><li>"Read" - allows to see created webhooks</li><li>"Update" - allows to edit webhooks</li><li>"Delete" - allows to delete webhooks</li></ul></ul> 👉 Path reminder to Webhook settings: <br /> *General > Settings > Global Settings - Webhook* |
141141
| Users and Roles | <ul><li>Users</li><ul><li>"Create (invite)" - allows to create administrator accounts</li><li>"Read" - allows to see existing administrator accounts</li><li>"Update" - allows to edit administrator accounts</li><li>"Delete" - allows to delete administrator accounts</li></ul></ul><ul><li>Roles</li><ul><li>"Create" - allows to create administrator roles</li><li>"Read" - allows to see created administrator roles</li><li>"Update" - allows to edit administrator roles</li><li>"Delete" - allows to delete administrator roles</li></ul></ul> 👉 Path reminder to the RBAC feature: <br /> *General > Settings > Administration Panel* |
142-
| Review Workflows <EnterpriseBadge /> | <ul><li>General</li><ul><li>"Access the Review workflows settings page"</li></ul></ul> 👉 Path reminder to Review workflows settings: <br /> *General > Settings > Global Settings - Review workflows* |
142+
| Review Workflows <EnterpriseBadge /> | <ul><li>"Create" - allows to create workflows</li><li>"Read" - allows to see created workflows</li><li>"Update" - allows to edit workflows</li><li>"Delete" - allows to delete workflows</li></ul> 👉 Path reminder to Review workflows settings: <br /> *General > Settings > Global Settings - Review workflows* |
143143

144144
</TabItem>
145145

-112 KB
Binary file not shown.
396 KB
Loading
391 KB
Loading
-93.5 KB
Binary file not shown.
409 KB
Loading
401 KB
Loading
355 KB
Loading
360 KB
Loading

0 commit comments

Comments
 (0)