diff --git a/CHANGELOG.txt b/CHANGELOG.txt index a9c507d0a7..ddf2aaaaff 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -73,6 +73,12 @@ Changelog * Fix: Changed relation name used for admin commenting from `comments` to `wagtail_admin_comments` to avoid conflicts with third-party commenting apps (Matt Westcott) +2.14.2 (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.14.1 (12.08.2021) ~~~~~~~~~~~~~~~~~~~ diff --git a/docs/releases/2.14.2.rst b/docs/releases/2.14.2.rst new file mode 100644 index 0000000000..46cbead6e2 --- /dev/null +++ b/docs/releases/2.14.2.rst @@ -0,0 +1,34 @@ +============================================= +Wagtail 2.14.2 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.14.2 alongside Wagtail's admin commenting functionality. diff --git a/docs/releases/index.rst b/docs/releases/index.rst index a48660acf9..953aac0215 100644 --- a/docs/releases/index.rst +++ b/docs/releases/index.rst @@ -6,6 +6,7 @@ Release notes upgrading 2.15 + 2.14.2 2.14.1 2.14 2.13.5