Release notes and version for 5.0 beta

Author: vsalvino

coderedcms/__init__.py

@@ -15,7 +15,7 @@
 See: https://www.python.org/dev/peps/pep-0440/
 """
 
-release = ["4", "0", "0", "", "dev0"]
+release = ["5", "0", "0", "b1", ""]
 
 
 def _get_version() -> str:

docs/features/spam-protection.rst

@@ -3,7 +3,7 @@ Spam Protection
 
 CRX provides features to help block spam form submissions from your site.
 
-These can be toggled in **CRX Settings > Forms**
+These can be toggled in **Settings > CRX Settings > Forms**
 
 
 Basic (honeypot)
@@ -19,9 +19,9 @@ reCAPTCHA v3 (invisible)
 
 Google's reCAPTCHA v3 is invisible, meaning the visitor does not see anything and does not have to solve any challenges. This works by generating a score of how likely the submission is to be spam.
 
-By default, CRX will show a generic error message for scores lower than 0.5. This can be adjusted in **CRX Settings > Forms**. If your visitors are complaining that they are getting errors when submitting forms, you may want to lower this number. If you are still receiving a lot of spam submissions, you may want to raise it.
+By default, CRX will show a generic error message for scores lower than 0.5. This can be adjusted in **Settings > CRX Settings > Forms**. If your visitors are complaining that they are getting errors when submitting forms, you may want to lower this number. If you are still receiving a lot of spam submissions, you may want to raise it.
 
-**reCAPTCHA v3 requires API keys from Google.** When creating the API keys, you must select recAPTCHA v3, then enter those keys into **CRX Settings > Forms**.
+**reCAPTCHA v3 requires API keys from Google.** When creating the API keys, you must select recAPTCHA v3, then enter those keys into **Settings > CRX Settings > Forms**.
 
 `Create reCAPTCHA API keys <https://www.google.com/recaptcha/admin/create>`_
 
@@ -31,7 +31,7 @@ reCAPTCHA v2 ("I am not a robot")
 
 Google's reCAPTCHA v2 shows the famous "I am not a robot" checkbox on the form. This requires the visitor to click the box. In some cases, Google might require the visitor to solve a challenge, such as selecting images or solving a puzzle.
 
-**reCAPTCHA v2 requires API keys from Google.** When creating the API keys, you must select recAPTCHA v2 "I am not a robot", then enter those keys into **CRX Settings > Forms**.
+**reCAPTCHA v2 requires API keys from Google.** When creating the API keys, you must select recAPTCHA v2 "I am not a robot", then enter those keys into **Settings > CRX Settings > Forms**.
 
 `Create reCAPTCHA API keys <https://www.google.com/recaptcha/admin/create>`_
 

docs/releases/index.rst

@@ -31,6 +31,7 @@ Supported Versions:
 .. toctree::
     :maxdepth: 1
 
+    v5.0.0
     v4.1.1
     v4.1.0
     v4.0.1

docs/releases/v5.0.0.rst

@@ -0,0 +1,82 @@
+v5.0.0 release notes
+====================
+
+5.0 is currently in beta. All features are complete except for the addition of Wagtail Block Previews (Wagtail 6.4), which may take extensive time to complete based on the large number of blocks provided by CRX.
+
+New features
+------------
+
+* Support Wagtail 6.4.
+
+* Support Python 3.9 to 3.13.
+
+* NEW: SEO preview on each page. Read more on our blog post `SEO Previews in Wagtail <https://www.coderedcorp.com/blog/seo-previews-in-wagtail/>`_.
+
+* NEW: spam protection with Google reCAPTCHA v2 and v3 on forms. See: :doc:`/features/spam-protection`
+
+
+Maintenance
+-----------
+
+* ``wagtail_flexible_forms`` module has been split out into its own package. No action is required. See `wagtail-flexible-forms <https://docs.coderedcorp.com/wagtail-flexible-forms/>`_.
+
+* Large cleanup of deprecated code. See upgrade considerations below.
+
+
+Upgrade considerations
+----------------------
+
+In addition to the changes below, be sure to read the `Wagtail 6.4 upgrade considerations <https://docs.wagtail.org/en/stable/releases/6.4.html#upgrade-considerations-changes-affecting-all-projects>`_.
+
+
+SEO fields have moved
+~~~~~~~~~~~~~~~~~~~~~
+
+Structured data about the organization was previously available on every page (under the **SEO** tab in the page editor). Now, organization data has been moved into the site settings under **Settings > SEO**.
+
+For most sites, no action is required, as the organization data is automatically copied from each site's Home Page to these settings.
+
+However, if you were previously using custom organization data on many separate pages, you'll need to follow the `wagtail-seo 3 upgrade instructions <https://docs.coderedcorp.com/wagtail-seo/getting-started/migration-3.html>`_
+
+Preview options removed from Pages and Blocks
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For most sites, no action is required as these have been deprecated and replaced by miniview templates back in :doc:`version 2.1 <v2.1.0>`.
+
+However, if you have any custom code using these deprecated fields or templates, replace them with custom miniview templates on relevant page models instead.
+
+* ``PagePreviewBlock`` fields removed:
+
+  * show_previews
+
+* ``CoderedArticleIndexPage`` fields removed:
+
+  * show_images
+
+  * show_captions
+
+  * show_meta
+
+  * show_preview_text
+
+* Template options (in block Advanced Settings) have been removed from ``PageListBlock`` and ``PagePreviewBlock``.
+
+* If you have ``CRX_FRONTEND_TEMPLATES_BLOCKS`` in your Django settings, remove the ``pagelistblock`` and ``pagepreviewblock`` entries from that dictionary.
+
+* Corresponding ``pagelist_*.html`` and ``pagepreview_*.html`` templates have been removed from the project.
+
+Migrations
+~~~~~~~~~~
+
+After upgrading, be sure to generate and apply new migrations as so:
+
+.. code-block::
+
+   python manage.py makemigrations
+   python manage.py migrate
+
+
+Thank you!
+----------
+
+Thanks to everyone who contributed to `5.0.0 on GitHub <https://github.com/coderedcorp/coderedcms/milestone/54?closed=1>`_.