Doc updates and release notes for 4.1

vsalvino · vsalvino · commit 6ae115826f1d · 2024-11-14T14:59:52.000-05:00
diff --git a/docs/features/page_types/event_pages.rst b/docs/features/page_types/event_pages.rst
@@ -31,7 +31,7 @@ Content Tab
 Implementation
 --------------
 
-The event functionality is built-in to Wagtail CRX but it is not enabled by default.
+The event functionality is built-in to Wagtail CRX which includes the ability to show events on a calendar, generate ical entries, and automatically rotate events based on next upcoming occurrences.
 
 There are two abstract pages available when dealing with events.  The first ``CoderedEventPage`` holds
 the information regarding an event.  Dates, location, etc. all will fall under this page.  The
@@ -80,17 +80,16 @@ create the new pages in your project.
 
 Now when going to the wagtail admin, you can create an Event Landing Page, and child Event Pages.
 
-.. versionadded:: 0.22
+.. note::
+
+   Events require timezone support to be enabled in Django. Be sure to set ``USE_TZ = True`` and ``TIME_ZONE`` in your settings.
+
+   All dates and times inputted via the Wagtail Admin, and rendered on the calendar and throughout the site, will be converted to ``TIME_ZONE`` from your Django settings.
 
-    All dates and times inputted via the Wagtail Admin, and rendered on the
-    calendar and throughout the site, will be converted to ``TIME_ZONE`` from
-    your Django settings. It is highly recommended to set ``TIME_ZONE`` and
-    ``USE_TZ = True`` in your Django settings for the Event pages to function
-    correctly.
+   For example, if ``TIME_ZONE`` is set to ``America/New_York``, then entering an event for 2021-12-31 09:00 in the Wagtail admin will be saved as 9am New York time. It will also be displayed on the website as 9am New York time.
 
-    For example, if ``TIME_ZONE`` is set to ``America/New_York``, then entering
-    an event for 2021-12-31 09:00 in the Wagtail admin will be saved as 9am New
-    York time. It will also be displayed on the website as 9am New York time.
+   If you then changed ``TIME_ZONE`` to ``America/Chicago``, the event time will automatically be displayed as 8am Chicago time.
+
+.. versionadded:: 0.22
 
-    If you then changed ``TIME_ZONE`` to ``America/Chicago``, the event time
-    will automatically be displayed as 8am Chicago time.
+   Events were added in 0.22
diff --git a/docs/hosting/index.rst b/docs/hosting/index.rst
@@ -0,0 +1,6 @@
+Deploying & Hosting Wagtail CRX
+===============================
+
+Wagtail CRX can be deployed and hosted just like any other Wagtail or Django website. Read the `Wagtail hosting guide <https://docs.wagtail.org/en/stable/deployment/index.html>`_.
+
+CodeRed also provides `CodeRed Cloud, optimized for deploying and hosting wagtail sites <https://www.codered.cloud/docs/wagtail/quickstart/>`_, which includes both free and professional grade plans.
diff --git a/docs/index.rst b/docs/index.rst
@@ -76,4 +76,5 @@ Contents
    how_to/index
    reference/index
    contributing/index
+   Deploying & hosting <hosting/index>
    releases/index
diff --git a/docs/releases/index.rst b/docs/releases/index.rst
@@ -15,6 +15,8 @@ Supported Versions:
 +--------------+---------+----------+---------------------------+
 | CRX version  | Wagtail | Python   | Support Status            |
 +==============+=========+==========+===========================+
+| CRX 4.1      | 6.3     | 3.9-3.13 | Supported                 |
++--------------+---------+----------+---------------------------+
 | CRX 4.x      | 6.x     | 3.8-3.12 | Supported                 |
 +--------------+---------+----------+---------------------------+
 | CRX 3.x      | 5.x     | 3.8-3.12 | Supported                 |
@@ -29,6 +31,7 @@ Supported Versions:
 .. toctree::
     :maxdepth: 1
 
+    v4.1.0
     v4.0.1
     v4.0.0
     v3.0.4
diff --git a/docs/releases/v4.1.0.rst b/docs/releases/v4.1.0.rst
@@ -0,0 +1,63 @@
+v4.1.0 release notes
+====================
+
+
+New features
+------------
+
+* Support Wagtail 6.3 exclusively.
+
+* Support Python 3.9 to 3.13.
+
+* Improve visual consistency of miniview and search templates, including uniform height when rendered in rows, i.e. Related Pages.
+
+* New miniview template for Article and Event pages, which show more contextual details about each page type.
+
+* All miniview templates now include variables ``h`` to set the heading level, and ``miniview_css_class`` to add CSS to the top level card.
+
+* New search template for Event pages which shows more contextual details.
+
+
+Bug fixes
+---------
+
+* Fix modal and download buttons by restoring ``button_title`` field on ``ButtonMixin`` (which was previously refactored in v4.0).
+
+* Fix accessibility warnings about inconsistent heading levels of Related Pages.
+
+* Fix visual overflow of Carousel block.
+
+* Fix default field type on Form page fields.
+
+
+Maintenance
+-----------
+
+* Update to the latest fullcalendar, icalendar, and django-bootstrap5 versions.
+
+
+Upgrade considerations
+----------------------
+
+After upgrading, be sure to generate and apply new migrations as so:
+
+.. code-block::
+
+   python manage.py makemigrations
+   python manage.py migrate
+
+Template changes
+~~~~~~~~~~~~~~~~
+
+The default Article Index and Event Index page templates now use the respective miniview template to list child pages. This results in a slight visual difference.
+
+Block changes
+~~~~~~~~~~~~~
+
+* ``button_title`` has been re-added to ``ButtonMixin``.
+
+
+Thank you!
+----------
+
+Thanks to everyone who contributed to `4.1 on GitHub <https://github.com/coderedcorp/coderedcms/milestone/56?closed=1>`_.
