Add 2.1 docs, doc cleanup

Author: vsalvino

docs/features/blocks/contentblocks/latestpages.rst

@@ -10,9 +10,9 @@ Fields and purposes:
 
 * **Parent Page** - Shows a preview of pages that are children of the selected page. Uses ordering specified in the page’s LAYOUT tab.
 
-* **Classified By** - Filters which pages are displayed by the classifier that you selected
+* **Classified By** - Filters which pages are displayed by the classifier that you selected.
 
-* **Number of Pages to Show** - Limits how many pages are displayed to the number that you selected
+* **Number of Pages to Show** - Limits how many pages are displayed to the number that you selected.
 
 Each page is rendered using the page model's "miniview" template.
 The template can be overridden per model with the ``miniview_template`` attribute, the default of which is `coderedcms/pages/page.mini.html <https://github.com/coderedcorp/coderedcms/blob/dev/coderedcms/templates/coderedcms/pages/pages.mini.html>`_.
@@ -27,6 +27,10 @@ The template can be overridden per model with the ``miniview_template`` attribut
 
     The Latest Pages block as displayed on the website.
 
+.. versionadded:: 2.1
+
+   Miniview templates were added in Wagtail CRX 2.1
+
 .. deprecated:: 2.1
 
    * "Show Body Preview" field was deprecated in 2.1 and will be removed in 3.0.

docs/features/blocks/contentblocks/pagepreview.rst

@@ -17,3 +17,7 @@ There is only one field.
 
 The selected page is rendered using the page model's "miniview" template.
 The template can be overridden per model with the ``miniview_template`` attribute, the default of which is `coderedcms/pages/page.mini.html <https://github.com/coderedcorp/coderedcms/blob/dev/coderedcms/templates/coderedcms/pages/pages.mini.html>`_.
+
+.. versionadded:: 2.1
+
+   Miniview templates were added in Wagtail CRX 2.1

docs/features/related_pages.rst

@@ -1,10 +1,6 @@
 Related Pages
 =============
 
-.. versionadded:: 2.1
-
-    Added related pages system. You must be on Wagtail CRX version 2.1 or higher in order to follow this guide.
-
 Using the power of :doc:`/features/snippets/classifiers`, pages can automatically show a list of similarly classified pages. By default, this is enabled on :doc:`/features/page_types/article_pages`, but can be enabled on any page via the Wagtail Admin, or a 1-line code change on the page model.
 
 .. figure:: img/related_pages.png
@@ -61,3 +57,7 @@ If you'd instead prefer to totally customize the related algorithm, override the
        def get_related_pages(self) -> models.QuerySet:
            """Show most expensive products first."""
            return ProductPage.objects.live().order_by("-price")
+
+.. versionadded:: 2.1
+
+   You must be on Wagtail CRX version 2.1 or higher to use related pages.

docs/features/snippets/filmstrip.rst

@@ -32,3 +32,7 @@ To add a slide to your carousel, click the "Add Slides" button.
 **Custom CSS class**: If you need to add a specific CSS class for this panel, add it here.
 **Custom ID**: If you need to add a specific ID for this panel, add it here.
 **Content**: A streamfield that contains the content blocks for the panel.
+
+.. versionadded:: 2.1
+
+   You must be on Wagtail CRX version 2.1 or higher to use Film Strips.

docs/releases/index.rst

@@ -6,15 +6,26 @@ Wagtail CRX (previously CodeRed CMS) follows the
 
 * **Major** - significant changes that may not be backwards compatible.
 
-* **Minor** - new features, enhancements, and bug fixes that are most likely
-  but not guaranteed to be backwards compatible.
+* **Minor** - new features, enhancements, and bug fixes that are most likely but not guaranteed to be backwards compatible.
 
-* **Patch** - guaranteed to be backwards compatible. These changes are
-  reserved for bug, security, or documentation fixes only.
+* **Patch** - guaranteed to be backwards compatible. These changes are reserved for bug, security, or documentation fixes only.
+
+Supported Versions:
+
++--------------+---------+----------+---------------------------+
+| CRX version  | Wagtail | Python   | Support Status            |
++==============+=========+==========+===========================+
+| CRX 2.x      | 4.x     | 3.7-3.11 | Supported                 |
++--------------+---------+----------+---------------------------+
+| CRX 1.x      | 3.x     | 3.7-3.11 | Support contract required |
++--------------+---------+----------+---------------------------+
+| CRX 0.25     | 2.16    | 3.7-3.10 | Support contract required |
++--------------+---------+----------+---------------------------+
 
 .. toctree::
     :maxdepth: 1
 
+    v2.1.0
     v2.0.0
     v1.0.3
     v1.0.2

docs/releases/v2.0.0.rst

@@ -5,15 +5,15 @@ v2.0.0 release notes
 New features
 ------------
 
-* CRX no longer pins the minor version of Wagtail. 2.x series will work with any version of Wagtail 4.
+* CRX no longer pins the minor version of Wagtail.
 
 * Support Wagtail 4.0, 4.1, and 4.2.
 
 
 Upgrade considerations
 ----------------------
 
-While there are no functional changes in CRX, there are many changes in Wagtail 4. Most CRX sites should not be impacted, however if your site implements custom functionality beyond what CRX provides, review the `Wagtail 4 release notes and upgrade considerations <https://docs.wagtail.org/en/stable/releases/4.0.html>`.
+While there are no functional changes in CRX, there are many changes in Wagtail 4. Most CRX sites should not be impacted, however if your site implements custom functionality beyond what CRX provides, review the `Wagtail 4 release notes and upgrade considerations <https://docs.wagtail.org/en/stable/releases/4.0.html>`_.
 
 If you are upgrading from an older version of CRX (0.x series) it is highly recommended to upgrade to 1.0 before attempting to upgrade to 2.0.
 

docs/releases/v2.1.0.rst

@@ -0,0 +1,53 @@
+v2.1.0 release notes
+====================
+
+
+New features
+------------
+
+* New snippet and block: :doc:`/features/snippets/filmstrip`.
+
+* New system-wide feature: :doc:`/features/related_pages`.
+
+* New template rendering option for page models, the "miniview". Instead of a full page template, this is used to render a small preview of the page in other places on the site, usually in a Bootstrap card format. The miniview template is used by:
+
+  * :doc:`/features/related_pages`
+
+  * :doc:`/features/blocks/contentblocks/pagepreview`
+
+  * :doc:`/features/blocks/contentblocks/latestpages`
+
+
+Upgrade considerations
+----------------------
+
+The built-in template options under Page Preview and Latest Pages block **Advanced Settings** are deprecated as of 2.1 and will be removed in 3.0. These have been replaced with identical miniview templates for Article and Form pages. **If you have overridden these templates** it is recommended to set your custom instead on the page model's ``miniview_template`` field.
+
+The new related pages feature is on by default for any newly created pages based on ``CoderedArticlePage``.
+
+* If you do not want this feature, disable it by setting ``related_show_default=False`` on your Article model.
+
+* If you want this feature retroactively on existing pages, write a simple query or migration to turn it on for those pages:
+
+  .. code-block:: python
+
+     # To enable related pages on just Article pages:
+     from website.models import ArticlePage
+     ArticlePage.objects.all().update(related_show=True)
+
+     # To enable related pages on all pages of the site:
+     from coderedcms.models import CoderedPage
+     CoderedPage.objects.all().update(related_show=True)
+
+As always, be sure to make and apply migrations after upgrading:
+
+.. code-block:: text
+
+   python manage.py makemigrations
+   python manage.py migrate
+
+
+Thank you!
+----------
+
+Thanks to everyone who contributed to `2.1.0 on GitHub <https://github.com/coderedcorp/coderedcms/milestone/46?closed=1>`_.