From 5aa0673452ca5e3306622e89bb425f5acdcf326e Mon Sep 17 00:00:00 2001 From: Matt Westcott Date: Thu, 19 Sep 2024 11:51:22 +0100 Subject: [PATCH] Update `WAGTAIL_WORKFLOW_REQUIRE_REAPPROVAL_ON_EDIT` docs to indicate that default is False (#12340) Fixes #12329 --- CHANGELOG.txt | 1 + docs/reference/settings.md | 2 +- docs/releases/6.3.md | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.txt b/CHANGELOG.txt index cffe0674ba42..7180cf8ffa37 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -30,6 +30,7 @@ Changelog * Docs: Document how to customize date/time format settings (Vince Salvino) * Docs: Create a new documentation section for deployment and move fly.io deployment from the tutorial to this section (Vince Salvino) * Docs: Clarify process for UserViewSet customization (Sage Abdullah) + * Docs: Correct `WAGTAIL_WORKFLOW_REQUIRE_REAPPROVAL_ON_EDIT` documentation to state that it defaults to `False` (Matt Westcott) * Maintenance: Removed support for Python 3.8 (Matt Westcott) * Maintenance: Drop pytz dependency in favour of `zoneinfo.available_timezones` (Sage Abdullah) * Maintenance: Relax django-taggit dependency to allow 6.0 (Matt Westcott) diff --git a/docs/reference/settings.md b/docs/reference/settings.md index 5e34249d2518..acc275674387 100644 --- a/docs/reference/settings.md +++ b/docs/reference/settings.md @@ -923,7 +923,7 @@ Specifies whether moderation workflows are enabled (default: `True`). When disab WAGTAIL_WORKFLOW_REQUIRE_REAPPROVAL_ON_EDIT = True ``` -Moderation workflows can be used in two modes. The first is to require that all tasks must approve a specific page revision for the workflow to complete. As a result, if edits are made to a page while it is in moderation, any approved tasks will need to be re-approved for the new revision before the workflow finishes. This is the default, `WAGTAIL_WORKFLOW_REQUIRE_REAPPROVAL_ON_EDIT = True` . The second mode does not require reapproval: if edits are made when tasks have already been approved, those tasks do not need to be reapproved. This is more suited to a hierarchical workflow system. To use workflows in this mode, set `WAGTAIL_WORKFLOW_REQUIRE_REAPPROVAL_ON_EDIT = False`. +Moderation workflows can be used in two modes. The first is to require that all tasks must approve a specific page revision for the workflow to complete. As a result, if edits are made to a page while it is in moderation, any approved tasks will need to be re-approved for the new revision before the workflow finishes. To use workflows in this mode, set `WAGTAIL_WORKFLOW_REQUIRE_REAPPROVAL_ON_EDIT = True`. The second mode does not require reapproval: if edits are made when tasks have already been approved, those tasks do not need to be reapproved. This is more suited to a hierarchical workflow system. This is the default, `WAGTAIL_WORKFLOW_REQUIRE_REAPPROVAL_ON_EDIT = False`. ### `WAGTAIL_FINISH_WORKFLOW_ACTION` diff --git a/docs/releases/6.3.md b/docs/releases/6.3.md index 1f6f521a7a69..d935b0227300 100644 --- a/docs/releases/6.3.md +++ b/docs/releases/6.3.md @@ -48,6 +48,7 @@ This release adds formal support for Django 5.1. * Document how to [customize date/time format settings](wagtail_date_time_formats) (Vince Salvino) * Create a new documentation section for [deployment](deployment_guide) and move `fly.io` deployment from the tutorial to this section (Vince Salvino) * Clarify process for [UserViewSet customization](custom_userviewset) (Sage Abdullah) + * Correct `WAGTAIL_WORKFLOW_REQUIRE_REAPPROVAL_ON_EDIT` documentation to state that it defaults to `False` (Matt Westcott) ### Maintenance