Home Explore Help
Sign In
CityApper
/
coderedcms
mirror of https://github.com/coderedcorp/coderedcms
2
0
Fork 0
Files Issues 0 Wiki
Tree: 9ab5b3ff93
Branches Tags
coderedcms
/
docs
/
releases
/
v0.21.0.rst

v0.21.0.rst 4.2 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107 
  1. v0.21.0 release notes
    2. 

  2. =====================
    3. 

  3. 

  4. 

  5. New features
    6. 

  6. ------------
    7. 

  7. 

  8. * Upgraded to Wagtail 2.13
    9. 

  9. 

  10. * Added new ``<head>`` and ``<body>`` tracking script settings. See
    11. 

  11.   :doc:`/how_to/add_tracking_scripts`.
    12. 

  12. 

  13. * Added new ``coderedcms.fields.MonospaceField`` for rendering text area fields
    14. 

  14.   in the Wagtail admin with monospace input and spell-checking disabled. This is
    15. 

  15.   used by the new tracking settings and is useful for implementing code-oriented
    16. 

  16.   fields.
    17. 

  17. 

  18. * Improve developer tooling in new CodeRed CMS sites by providing pre-configured
    19. 

  19.   ``.gitattribute`` and ``.editorconfig`` files.
    20. 

  20. 

  21. * SEO features have been refactored into separate package ``wagtail-seo``. There
    22. 

  22.   should be no noticeable changes to your models, except for the addition of new
    23. 

  23.   properties which can be easily overridden and customized. See
    24. 

  24.   `wagtail-seo customization docs <https://docs.coderedcorp.com/wagtail-seo/customizing/index.html>`_.
    25. 

  25. 

  26. 

  27. Upgrade considerations
    28. 

  28. ----------------------
    29. 

  29. 

  30. * Existing projects will need to add ``wagtailseo,`` to ``INSTALLED_APPS``
    31. 

  31.   (usually in ``settings/base.py``).
    32. 

  32. 

  33. * **AMP support has been removed**. This means that your site will no longer
    34. 

  34.   serve automatically generated AMP pages after upgrading. If you had previously
    35. 

  35.   implemented custom AMP templates, or rely heavily on AMP pages, you may need
    36. 

  36.   to implement this functionality yourself. For any site what is not a large
    37. 

  37.   news publisher, we recommend removing AMP from your site, as it is no longer
    38. 

  38.   worth the maintenance burden. `See reasoning for this change
    39. 

  39.   <https://github.com/coderedcorp/wagtail-seo/issues/21>`_.
    40. 

  40. 

  41.   * ``coderedcms_tags.convert_to_amp`` has been removed.
    42. 

  42. 

  43.   * ``coderedcms.utils.convert_to_amp()`` has been removed.
    44. 

  44. 

  45.   * You should remove any ``amp_template`` attributes from your models, as they
    46. 

  46.     are no longer used.
    47. 

  47. 

  48. * ``coderedcms/pages/base.html`` template has been modified. If you implement or
    49. 

  49.   extend your own ``base.html``, the following changes are notable:
    50. 

  50. 

  51.   * template blocks: ``html_seo_base``, ``html_seo_extra``, ``og_seo_base``,
    52. 

  52.     ``og_seo_extra``, ``twitter_seo_base``, ``twitter_seo_extra`` have been
    53. 

  53.     replaced with ``{% include "wagtailseo/meta.html" %}``
    54. 

  54. 

  55.   * template blocks: ``struct_seo_base``, ``struct_seo_extra`` have been
    56. 

  56.     replaced with ``{% include "wagtailseo/struct_data.html" %}``
    57. 

  57. 

  58. * Properties and templates associated with SEO functionality have changed:
    59. 

  59. 

  60.   * ``CoderedArticlePage.get_author_name`` -> ``CoderedArticlePage.seo_author``
    61. 

  61. 

  62.   * ``CoderedArticlePage.get_pub_date`` -> ``CoderedArticlePage.seo_published_at``
    63. 

  63. 

  64.   * ``CoderedArticlePage.get_description`` -> ``CoderedArticlePage.seo_description``
    65. 

  65. 

  66.   * ``coderedcms_tags.og_image`` -> ``page.seo_image_url``
    67. 

  67. 

  68.   * ``coderedcms_tags.structured_data_datetime`` has been removed.
    69. 

  69. 

  70. * Some built-in blocks used in the Wagtail admin have been replaced:
    71. 

  71. 

  72.   * ``coderedcms.blocks.MultiSelectBlock`` -> ``wagtail.core.blocks.MultipleChoiceBlock``
    73. 

  73. 

  74.   * ``coderedcms.blocks.OpenHoursValue`` -> ``wagtailseo.blocks.OpenHoursValue``
    75. 

  75. 

  76.   * ``coderedcms.blocks.OpenHoursBlock`` -> ``wagtailseo.blocks.OpenHoursBlock``
    77. 

  77. 

  78.   * ``coderedcms.blocks.StructuredDataActionBlock`` -> ``wagtailseo.blocks.StructuredDataActionBlock``
    79. 

  79. 

  80. * CodeRed CMS now sets ``default_auto_field = 'django.db.models.AutoField'`` for
    81. 

  81.   its own concrete models. If you had previously manually specified a different
    82. 

  82.   ``DEFAULT_AUTO_FIELD`` Django setting, you may need to create a migration.
    83. 

  83. 

  84. * You may need to find/replace
    85. 

  85.   ``coderedcms.blocks.base_blocks.MultiSelectBlock`` with
    86. 

  86.   ``wagtail.core.blocks.MultipleChoiceBlock`` in any old migrations so that they
    87. 

  87.   may continue working.
    88. 

  88. 

  89. * Follow `Wagtail 2.12 upgrade considerations <https://docs.wagtail.io/en/stable/releases/2.12.html#upgrade-considerations>`_
    90. 

  90.   and `Wagtail 2.13 upgrade considerations <https://docs.wagtail.io/en/stable/releases/2.13.html#upgrade-considerations>`_.
    91. 

  91. 

  92. * You may need to run ``python manage.py makemigrations website`` and
    93. 

  93.   ``python manage.py migrate`` after upgrading.
    94. 

  94. 

  95. 

  96. Supported software
    97. 

  97. ------------------
    98. 

  98. 

  99. * Python 3.6, 3.7, 3.8, 3.9
    100. 

  100. 

  101. * Django 2.2, 3.0, 3.1, 3.2
    102. 

  102. 

  103. 

  104. Thank you!
    105. 

  105. ----------
    106. 

  106. 

  107. Thanks to everyone who contributed to `0.21.0 on GitHub <https://github.com/coderedcorp/coderedcms/milestone/31?closed=1>`_.
    108.