From 80d2f2bc361960fbb60eae74a87847f57a40b7a1 Mon Sep 17 00:00:00 2001 From: Matt Westcott Date: Wed, 13 Oct 2021 21:24:58 +0100 Subject: [PATCH] Release note for #7591 in 2.13.5 --- CHANGELOG.txt | 6 ++++++ docs/releases/2.13.5.rst | 34 ++++++++++++++++++++++++++++++++++ docs/releases/index.rst | 1 + 3 files changed, 41 insertions(+) create mode 100644 docs/releases/2.13.5.rst diff --git a/CHANGELOG.txt b/CHANGELOG.txt index d981fa2506..a9c507d0a7 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -120,6 +120,12 @@ Changelog * Fix: Ensure that rich text conversion correctly handles images / embeds inside links or inline styles (Matt Westcott) +2.13.5 (xx.xx.xxxx) - IN DEVELOPMENT +~~~~~~~~~~~~~~~~~~~ + + * Fix: Allow relation name used for admin commenting to be overridden to avoid conflicts with third-party commenting apps (Matt Westcott) + + 2.13.4 (13.07.2021) ~~~~~~~~~~~~~~~~~~~ diff --git a/docs/releases/2.13.5.rst b/docs/releases/2.13.5.rst new file mode 100644 index 0000000000..515315a2de --- /dev/null +++ b/docs/releases/2.13.5.rst @@ -0,0 +1,34 @@ +============================================= +Wagtail 2.13.5 release notes - IN DEVELOPMENT +============================================= + +.. contents:: + :local: + :depth: 1 + + +What's new +========== + +Bug fixes +~~~~~~~~~ + + * Allow relation name used for admin commenting to be overridden to avoid conflicts with third-party commenting apps (Matt Westcott) + +Upgrade considerations +====================== + +Customising relation name for admin comments +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The admin commenting feature introduced in Wagtail 2.13 added a relation named ``comments`` to the Page and User +models. This can cause conflicts with third-party apps that implement commenting functionality, and so this will be +renamed to ``wagtail_admin_comments`` in Wagtail 2.15. Developers who are affected by this issue, and have thus been +unable to upgrade to Wagtail 2.13 or above, can now "opt in" to the Wagtail 2.15 behaviour by adding the following +line to their project settings: + +.. code-block:: python + + WAGTAIL_COMMENTS_RELATION_NAME = 'wagtail_admin_comments' + +This will allow third-party commenting apps to work in Wagtail 2.13.5 alongside Wagtail's admin commenting functionality. diff --git a/docs/releases/index.rst b/docs/releases/index.rst index 814ba73962..a48660acf9 100644 --- a/docs/releases/index.rst +++ b/docs/releases/index.rst @@ -8,6 +8,7 @@ Release notes 2.15 2.14.1 2.14 + 2.13.5 2.13.4 2.13.3 2.13.2