Django-icekit

-----------------

- Changed the way that we specify the homepage: create a page with url
override `/`. This is the way fluent does it. As a fallback, we look for a
page with slug `home`. If you mount pages under a page with override URL and
slug, the child pages inherit the override URL, making the page tree more
natural.

- Page Admin no longer replaces the change_list table with a tree.

- Provide default Localization formats.

- Improvements to Events admin and calendar. Calendar shows for single event.

- Better Date/Time/Datetime widgets in Admin forms

- Front-end improvements: updated preview links in templates, included
Bootstrap in backend and front-end by default.

- Added implementation of key parts of IIIF 2.1 spec for privileged users.

- Fleshed out Image model with more metadata and fields for rights/usage.

- Refactor ``icekit.admin*``, ``icekit.dashboard`` and
``icekit.utils.admin`` to ``icekit.admin_tools``
in preparation for admin consolidation and extension. Previous classes,
templates and functions are deprecated.

- A new setting ``ICEKIT['DASHBOARD_SORTED_APPS']`` to manually group
models in the list below the dashboard panels. Models that aren't
manually grouped are grouped by their apps as normal.

- New dashboard panels for Recent Actions (the Django admin changelist) and
Assigned To Me (a workflow list). ``WorkflowState`` gets a
``datetime_modified`` field to support this.

- ``raw_id``s have previews and edit links if the admin subclasses
``RawIdPreviewAdminMixin`` (which ICEkit's default admins do; note
``InlineAdmin``s do not need this subclass). If the linked object has a
``preview()`` method, it is used for the preview, wrapped in an 'edit'
link.

- New ``PreviewAdminMixin`` which calls an object's ``preview()`` method.
The existing ``ThumbnailAdminMixin`` now inherits from this class and
consequently, models which use ``ThumbnailAdminMixin`` have a visual
preview in ``raw_id`` fields, including ``icekit.plugins.image.Image``.

- The "icekit/admin/fluent_layouts_change_form.html" template has moved to
"admin/fluent_layouts_change_form.html". Please update your references.

- Add ``icekit.api`` application to provide APIs to read data from, and
sometimes write data to, items in the site from program clients.

- Relocate public-access and read-only API for published pages to the new
app location.

- Add new authenticated-access and permissions-based API for images.

- See documentation in *docs/topics/apis.rst*.

- Add ``icekit.workflow`` application to associate, manage, and filter
workflow state information like status and user-assigment for
arbitrary models.

- Add ``ICEkitContentsMixin`` and ``ICEkitFluentContentsMixin``
abstract classes in ``icekit.models`` to use as a base for models
that will include publishing and workflow features.

- Add ``ICEkitContentsAdmin`` and ``ICEkitFluentContentsAdmin`` admin
classes in ``icekit.admin`` as bases for admins for models with
publishing and workflow features.

- Add workflow features to all publishable models in ICEkit using the
new abstract model mixins and admin base classes mentioned above.

- Preview pages are now visually highlighted, and have a different HTML
title.

- "Preview draft" button is now near "View published" button.

- "Slideshow" is now renamed "Image Gallery" and there is a new Image
Gallery content plugin available (which renders a grid of thumbnails
into a lightbox).

- ``icekit.content_collections`` app which defines an abstract listing
page type that lists a collection of content, and an abstract model
for collected content that appears in such a collection. This is a
common pattern.

- New ``icekit.page_types.author`` app which models a content author
and a listing page, based on the ``content_collections`` pattern.

- New ``icekit.page_types.article`` app which is a concrete
implementation of the content collections pattern.

- Ignore ``.env`` and ``docker-cloud.*.yml`` files, which frequently
contain secrets that should not be committed.

- New ``ContactPerson`` model + and plugin added, allowing adding of
staff contacts to most types of content.

- Verbose Name for "o embed with caption" is now "Embedded media"

- Text plugin now has a style setting

- Overhaul of search system, using a consistent approach to index and
depict rich/publishable/polymorphic models, and to facet on them.

- Documentation is refactored into ReStructuredText. This means much
more coherence, and the ability to generate documentation from within
code. Also documentation focuses on GLAMkit rather than ICEkit to align
with current development focus.

Breaking changes
~~~~~~~~~~~~~~~~

- ``DASHBOARD_FEATURED_APPS[]['models']`` should now be a list of tuples, not
a dict, so that ordering is preserved. Dict-based definitions still work, but
operations that rely on the value being a dict (such as ``update()``)
will fail.

- ``AbstractLayoutPage`` now includes ListableMixin and HeroMixin. All
models which inherit from this will need a new migration.

- The initial migration for ``icekit.plugins.slideshow`` had the wrong
database table name, which meant that the ``0004_auto_20160821_2140``
migration would not have correctly renamed the database table when
upgrading to ``>=0.10`` from an earlier version.

To fix this, run the following SQL manually:

::

ALTER TABLE "slideshow_slideshow" RENAME TO "icekit_plugins_slideshow_slideshow";

If you have yet to upgrade from ``<0.10``, you don't need to do
anything.

- ``icekit.articles`` is no more. Functionality is moved to
``icekit.content_collections``.

- ``icekit.dashboard`` has moved to ``icekit.admin_tools``.

- The ``FEATURED_APPS`` setting has moved to
``ICEKIT['DASHBOARD_FEATURED_APPS']``, and the ``['models']`` values are now
tuples of 2-tuples, not dicts, so as to support item ordering.
``update()``ing the default settings no longer works, use tuple operations
instead.

- Added HeroMixin and ListableMixin to LayoutPage and Article. This
will break ported/subclass models that define similarly-named fields.
Either remove the definition or migrate data somehow.

- The required version of Press Releases removes the ``PressContact``
model, in favour of ``ContactPerson``. If you have ``PressContacts``,
you will need to migrate to the new model.

-----------------

- Improvements to publishing to make it accomodate more types of
content.

- Fix bug where the content items and placeholders associated with a
fluent content model (other than a page) were not included in the
published copy.

- Provide ``icekit.publishing.models.PublishableFluentContents`` and
``icekit.publishing.admin.PublishableFluentContentsAdmin`` as base
classes for fluent content models and admins, to help keep things
DRY.

- Minor docs on testing.

- Greater test coverage.

Breaking changes
~~~~~~~~~~~~~~~~

- Import model mixins ``FluentFieldsMixin``, ``LayoutFieldMixin``, and
``ReadabilityMixin`` from ``icekit.mixins`` module instead of
``icekit.abstract_models``.

- Import admin mixin ``FluentLayoutsMixin`` from
``icekit.admin_tools.mixins`` module instead of ``icekit.admin``.

-------------------

- ICEkit gets a facelift. Content editing now looks cleaner and easier
to scan. Reordering items is animated, meaning it's easier to keep
track of what got moved.

- Improved Image controls, optionally including a title in the caption.

- ``alt_text`` is no longer required - some images don't provide
content that is useful to users who can't see them, though the
``alt=`` attribute is still always included in HTML.

- Fix a bug where looking for ``help_text`` in a placeholder slot that
had no manual configuration raised a 500, resulting in no layout data
found.

- Fix fatal error (typo) in ``startproject.sh`` script.

- Update ``.editorconfig``, and add to project template.

- Tag Docker images during build on Travis CI for release versions.

-----------------

- Update the recommended method of running projects via ``Docker`` and
``go.sh`` to provide a more consistent and familiar experience for
developers.

Old:

::

$ docker-compose up Run all services and log to stdout (no interactivity)
$ docker-compose exec django entrypoint.sh Shell into running `django` container to run interactive processes

New:

::

$ docker-compose run --rm --service-ports django Start dependant services and shell into a new `django` container

The benefits are that:

1. We start with an interactive terminal in which we can any number
of interactive processes in a familiar way.

2. It's much easier and quicker to stop and restart the main process
(e.g. the Django dev server) without having to stop and restart
dependant services.

3. We aren't overwhelmed by several screens of log output from all
the service dependencies.

4. We don't start a WSGI process in a non-interactive ``django``
service, then have to shell into the container to stop it and
replace it with an interactive one.

- Use different locations for ``PYTHONUSERBASE`` (via Docker) and
virtualenv (via ``go.sh``) directories, to avoid conflicts.

- Isolate the ``go.sh`` BASH shell from user's personal ``.bashrc`` and
``.profile`` files to avoid conflicts and unexpected behaviour.

- Validate that manually installed dependencies are available when run
via ``go.sh``, and fail loudly.

- Call ``setup-django.sh`` by default when ``go.sh`` is called without
arguments, to mimic ``docker-compose run ... django`` default
behaviour.

- Improve the ``runtests.sh`` script:

1. Use a database name derived from project directory and Git branch.

2. Restore ``test_initial_data.sql`` instead of ``initial_data.sql``
before running tests, so ``initial_data.sql`` can be used for
development.

3. Only run and report on project tests when run in a project
context.

- Improve detection of ``*.sql`` file vs source database to restore
when creating a database.

- Don't clobber the version of ICEkit installed into the base Docker
image when building a project image.

- Avoid failing test builds when Coveralls fails to push its update.

- Add an authors app.

- You can now define ``help_text`` for a fluent placeholder in
``FLUENT_CONTENTS_PLACEHOLDER_CONFIG``.

- Improved ``ICEkitURLField``, which uses correct ``Page`` queryset.

Backwards incompatible changes:

- The default command for ``django`` service now starts an interactive
shell instead of ``supervisord.sh`` (which starts Nginx and
Gunicorn). Use the new
``docker-compose run --rm --service-ports django`` command to shell
into a new ``django`` container and then manually call
``runserver.sh`` or ``supervisord.sh`` instead of
``docker-compose up``.

- The ``entrypoint.sh`` script is now executed via the ``ENTRYPOINT``
instruction in ``Dockerfile``. You don't need to explicitly include
it as an argument to ``docker-compose run ...`` commands or in
``docker-compose.yml`` services.

- Move Node modules and Bower components out of ``icekit`` package and
into project template for simplicity and greater visibility. Add
ICEkit dependencies to your project ``bower.json`` and
``package.json`` files.

- Remove ``django-supervisor``. We are now using Supervisor directly
because it uses a lot of memory and is slow to invoke the whole
Django machinery just to render a ``supervisord.conf`` template
before starting Supervisor.

Define additional services in ``docker-compose.yml`` and a Supervisor
config file (referenced by the ``SUPERVISORD_CONFIG_INCLUDE``
environment variable) or shell scripts to run additional processes
interactively.

-------------------

- Refactored templates so as to only use bootstrap markup when layout
is intrinsic. Improved markup for some, particularly quote and
OEmbed.

- Added instructions covering uninstalling a docker project.

- Installation improvements.

- Thumbnail configuration should now be specified in settings, not
templates.

-----------------

- Make project run more consistently without Docker (via ``go.sh``).

- Refactor docs to provide better onboarding.

- Fix intermittent cache related test failures.