Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integration between the Releases and Review Workflows features #2273

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docusaurus/docs/user-docs/releases/managing-a-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,10 @@ Publishing a release means that all the actions (publish or unpublish) defined f
The _Status_ column displays the status of each entry:

- ![Success icon](/img/assets/icons/v5/CheckCircle.svg) Already published: the entry is already published and publishing the release will not affect this entry
- ![Success icon](/img/assets/icons/v5/CheckCircle.svg) Already unpublished: the entry is already unpublished, and publishing the release will not affect this entry.
- ![Success icon](/img/assets/icons/v5/CheckCircle.svg) Ready to publish: the entry is ready to be published with the release
- ![Fail icon](/img/assets/icons/v5/CrossCircle2.svg) "[field name] is required", "[field name] is too short" or "[field name] is too long": the entry cannot be published because of the issue stated in the red warning message. In this case, the release will be indicated as *Blocked* until all issues have been fixed.
- ![Success icon](/img/assets/icons/v5/CheckCircle.svg) Ready to unpublish: the entry is ready to be unpublished with the release
- ![Fail icon](/img/assets/icons/v5/CrossCircle2.svg) Not ready to publish: the entry cannot be published because some fields are incorrectly filled, or it hasn't reached the required stage for publishing. In this case, the release will be indicated as *Blocked* until all issues have been fixed.

If some of your entries have a ![Fail icon](/img/assets/icons/v5/CrossCircle2.svg) status, click the ![More icon](/img/assets/icons/v5/More.svg) and the **Edit the entry** button to fix the issues until all entries have the ![Success icon](/img/assets/icons/v5/CheckCircle.svg) status. Note that you will have to click on the **Refresh** button to update the release page as you fix the various entries issues.

Expand Down
3 changes: 2 additions & 1 deletion docusaurus/docs/user-docs/settings/review-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The Review Workflows feature allows you to create and manage workflows for your

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.

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.
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. Additionally, any stage can be defined as a required stage for publishing, ensuring content must pass through that stage before it can be published.

Before being available in the [Content Manager](/user-docs/content-manager/reviewing-content), review workflows must be configured from ![Settings icon](/img/assets/icons/v5/Cog.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.

Expand All @@ -46,6 +46,7 @@ Before being available in the [Content Manager](/user-docs/content-manager/revie
| Workflow name | Write a unique name of workflow. |
| Associated to | (optional) Assign this workflow to one or more existing content-types. |
| Stages | Add review stages (see [Adding a new stage](#adding-a-new-stage)). |
| Required stage | Define any stage as required for publishing. |

3. Click on the **Save** button. The new workflow will be displayed in the list-view and for every content-type assigned.

Expand Down
Binary file modified docusaurus/static/img/assets/releases/release-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.