2
0

v0.19.0.rst 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. v0.19.0 release notes
  2. =====================
  3. Bug fixes
  4. ---------
  5. * Support custom image models by correctly using ``WAGTAILIMAGES_IMAGE_MODEL``
  6. versus hard-coding ``wagtailimages.Image``.
  7. * Fix custom CSS class and Google Maps API key in Google Map block.
  8. * ``coderedcms start`` now pins the version of CodeRed CMS in the generated
  9. ``requirements.txt`` file.
  10. New features
  11. ------------
  12. * Upgraded to Wagtail 2.9
  13. * Upgraded to Bootstrap 4.5 and jQuery 3.5.1
  14. * Button and Link blocks can now link to fragments. See new :doc:`block
  15. documentation </features/blocks/index>`.
  16. * ``coderedcms start`` no longer creates a boilerplate Dockerfile. This has
  17. been replaced with a more thorough guide: :doc:`/how_to/docker`.
  18. * The boilerplate ``.scss`` files created when starting a new SASS project have
  19. been simplified. See upgrade considerations below if you'd like to simplify
  20. your ``.scss`` files created from an older version of CodeRed CMS.
  21. * As of 0.19, we will no longer maintain separate versions of docs for each
  22. release. The single stable docs will contain notes for each feature if that
  23. feature is changed, added, or removed in a particular release.
  24. Documentation
  25. -------------
  26. See the following new guides!
  27. * :doc:`/how_to/headers_and_footers`
  28. * :doc:`/how_to/docker`
  29. * :doc:`/how_to/use_custom_image_model`
  30. * :doc:`/how_to/convert_image_model`
  31. Upgrade considerations
  32. ----------------------
  33. * For Wagtail 2.9 ``SiteMiddleware`` and ``request.site`` are deprecated.
  34. Custom code in your project should be updated as so:
  35. * In python, replace ``request.site`` with ``Site.find_for_request(request)``.
  36. * In Python, to load a site setting, replace
  37. ``Setting.for_site(request.site)`` with ``Setting.for_request(request)``.
  38. * In HTML templates, replace ``request.site`` with:
  39. .. code-block:: html
  40. {% load wagtailcore_tags %}
  41. {% wagtail_site as site %}
  42. <p>Your site name is: {{site.site_name}}</p>
  43. * Following these changes, you should then remove
  44. ``wagtail.core.middleware.SiteMiddleware`` from the Django ``MIDDLEWARE``
  45. (in ``settings/base.py``)
  46. * If you have overridden ``coderedcms/pages/base.html``, you may need to update
  47. references to ``jquery-3.4.1`` to ``jquery-3.5.1``.
  48. * If using SASS, you may need to update your ``custom.scss`` and/or
  49. ``_variables.scss`` files accordingly to support Bootstrap 4.5. To see what
  50. you might need to change, see `the files from our sass starter project`_. Or
  51. to continue using Bootstrap 4.3, `download a copy of the Bootstrap 4.3
  52. sources`_ and change the references in your ``custom.scss`` to use these
  53. files.
  54. * It is assumed that all CodeRed CMS sites prior to 0.19 are using the built-in
  55. Wagtail Image model, as this was previously hard-coded in CodeRed CMS. If (and
  56. only if) you plan to switch to a custom image model, a custom data migration
  57. will be necessary. This migration would follow the same process as any other
  58. Wagtail installation; there is nothing unique relating to CodeRed CMS.
  59. * You may need to run ``python manage.py makemigrations website`` and
  60. ``python manage.py migrate`` after upgrading.
  61. .. _the files from our sass starter project: https://github.com/coderedcorp/coderedcms/tree/dev/coderedcms/project_template/sass/website/static/website/src
  62. .. _download a copy of the Bootstrap 4.3 sources: https://getbootstrap.com/docs/4.3/getting-started/download/
  63. Thank you!
  64. ----------
  65. Thanks to everyone who contributed to `0.19.0 on GitHub <https://github.com/coderedcorp/coderedcms/milestone/26?closed=1>`_.