Add 'wagtail_update_index' as an alias for the 'update_index' command (#5009)

Fixes #2447

CHANGELOG.txt

@@ -12,6 +12,7 @@ Changelog
  * Preserve links when copy-pasting rich text content from Wagtail to other tools (Thibaud Colas)
  * Rich text to contentstate conversion now prioritises more specific rules, to accommodate `<p>` and `<br>` elements with attributes (Matt Westcott)
  * Added limit image upload size by number of pixels (Thomas Elliott)
+ * Added `manage.py wagtail_update_index` alias to avoid clashes with `update_index` commands from other packages (Matt Westcott)
  * Fix: Set `SERVER_PORT` to 443 in `Page.dummy_request()` for HTTPS sites (Sergey Fedoseev)
  * Fix: Include port number in `Host` header of `Page.dummy_request()` (Sergey Fedoseev)
  * Fix: Validation error messages in `InlinePanel` no longer count towards `max_num` when disabling the 'add' button (Todd Dembrey, Thibaud Colas)

docs/reference/management_commands.rst

@@ -93,6 +93,14 @@ You can prevent the ``update_index`` command from indexing any data by using the
     $ python manage.py update_index --schema-only
 
 
+.. _wagtail_update_index:
+
+wagtail_update_index
+--------------------
+
+An alias for the ``update_index`` command that can be used when another installed package (such as `Haystack <http://haystacksearch.org/>`_) provides a command named ``update_index``. In this case, the other package's entry in ``INSTALLED_APPS`` should appear above ``wagtail.search`` so that its ``update_index`` command takes precedence over Wagtail's.
+
+
 .. _search_garbage_collect:
 
 search_garbage_collect

docs/releases/2.5.rst

@@ -22,6 +22,7 @@ Other features
  * Preserve links when copy-pasting rich text content from Wagtail to other tools (Thibaud Colas)
  * Rich text to contentstate conversion now prioritises more specific rules, to accommodate ``<p>`` and ``<br>`` elements with attributes (Matt Westcott)
  * Added limit image upload size by number of pixels (Thomas Elliott)
+ * Added ``manage.py wagtail_update_index`` alias to avoid clashes with ``update_index`` commands from other packages (Matt Westcott)
 
 
 Bug fixes

docs/topics/search/indexing.rst

@@ -56,6 +56,10 @@ It is recommended to run this command once a week and at the following times:
 
 The search may not return any results while this command is running, so avoid running it at peak times.
 
+.. note::
+
+    The ``update_index`` command is also aliased as ``wagtail_update_index``, for use when another installed package (such as `Haystack <http://haystacksearch.org/>`_) provides a conflicting ``update_index`` command. In this case, the other package's entry in ``INSTALLED_APPS`` should appear above ``wagtail.search`` so that its ``update_index`` command takes precedence over Wagtail's.
+
 
 .. _wagtailsearch_indexing_fields:
 

wagtail/search/management/commands/wagtail_update_index.py

@@ -0,0 +1,4 @@
+# Alias for the update_index command, to avoid clashes with other packages
+# that implement an update_index command (such as django-haystack)
+
+from wagtail.search.management.commands.update_index import Command  # NOQA