| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107 |
- v0.21.0 release notes
- =====================
- New features
- ------------
- * Upgraded to Wagtail 2.13
- * Added new ``<head>`` and ``<body>`` tracking script settings. See
- :doc:`/how_to/add_tracking_scripts`.
- * Added new ``wagtailcrx.fields.MonospaceField`` for rendering text area fields
- in the Wagtail admin with monospace input and spell-checking disabled. This is
- used by the new tracking settings and is useful for implementing code-oriented
- fields.
- * Improve developer tooling in new CodeRed CMS sites by providing pre-configured
- ``.gitattribute`` and ``.editorconfig`` files.
- * SEO features have been refactored into separate package ``wagtail-seo``. There
- should be no noticeable changes to your models, except for the addition of new
- properties which can be easily overridden and customized. See
- `wagtail-seo customization docs <https://docs.coderedcorp.com/wagtail-seo/customizing/index.html>`_.
- Upgrade considerations
- ----------------------
- * Existing projects will need to add ``wagtailseo,`` to ``INSTALLED_APPS``
- (usually in ``settings/base.py``).
- * **AMP support has been removed**. This means that your site will no longer
- serve automatically generated AMP pages after upgrading. If you had previously
- implemented custom AMP templates, or rely heavily on AMP pages, you may need
- to implement this functionality yourself. For any site what is not a large
- news publisher, we recommend removing AMP from your site, as it is no longer
- worth the maintenance burden. `See reasoning for this change
- <https://github.com/coderedcorp/wagtail-seo/issues/21>`_.
- * ``wagtailcrx_tags.convert_to_amp`` has been removed.
- * ``wagtailcrx.utils.convert_to_amp()`` has been removed.
- * You should remove any ``amp_template`` attributes from your models, as they
- are no longer used.
- * ``wagtailcrx/pages/base.html`` template has been modified. If you implement or
- extend your own ``base.html``, the following changes are notable:
- * template blocks: ``html_seo_base``, ``html_seo_extra``, ``og_seo_base``,
- ``og_seo_extra``, ``twitter_seo_base``, ``twitter_seo_extra`` have been
- replaced with ``{% include "wagtailseo/meta.html" %}``
- * template blocks: ``struct_seo_base``, ``struct_seo_extra`` have been
- replaced with ``{% include "wagtailseo/struct_data.html" %}``
- * Properties and templates associated with SEO functionality have changed:
- * ``CoderedArticlePage.get_author_name`` -> ``CoderedArticlePage.seo_author``
- * ``CoderedArticlePage.get_pub_date`` -> ``CoderedArticlePage.seo_published_at``
- * ``CoderedArticlePage.get_description`` -> ``CoderedArticlePage.seo_description``
- * ``wagtailcrx_tags.og_image`` -> ``page.seo_image_url``
- * ``wagtailcrx_tags.structured_data_datetime`` has been removed.
- * Some built-in blocks used in the Wagtail admin have been replaced:
- * ``wagtailcrx.blocks.MultiSelectBlock`` -> ``wagtail.core.blocks.MultipleChoiceBlock``
- * ``wagtailcrx.blocks.OpenHoursValue`` -> ``wagtailseo.blocks.OpenHoursValue``
- * ``wagtailcrx.blocks.OpenHoursBlock`` -> ``wagtailseo.blocks.OpenHoursBlock``
- * ``wagtailcrx.blocks.StructuredDataActionBlock`` -> ``wagtailseo.blocks.StructuredDataActionBlock``
- * CodeRed CMS now sets ``default_auto_field = 'django.db.models.AutoField'`` for
- its own concrete models. If you had previously manually specified a different
- ``DEFAULT_AUTO_FIELD`` Django setting, you may need to create a migration.
- * You may need to find/replace
- ``wagtailcrx.blocks.base_blocks.MultiSelectBlock`` with
- ``wagtail.core.blocks.MultipleChoiceBlock`` in any old migrations so that they
- may continue working.
- * Follow `Wagtail 2.12 upgrade considerations <https://docs.wagtail.io/en/stable/releases/2.12.html#upgrade-considerations>`_
- and `Wagtail 2.13 upgrade considerations <https://docs.wagtail.io/en/stable/releases/2.13.html#upgrade-considerations>`_.
- * You may need to run ``python manage.py makemigrations website`` and
- ``python manage.py migrate`` after upgrading.
- Supported software
- ------------------
- * Python 3.6, 3.7, 3.8, 3.9
- * Django 2.2, 3.0, 3.1, 3.2
- Thank you!
- ----------
- Thanks to everyone who contributed to `0.21.0 on GitHub <https://github.com/coderedcorp/wagtailcrx/milestone/31?closed=1>`_.
|
