From 1142123174b41f28d3e2bf03e9f460866de68fc8 Mon Sep 17 00:00:00 2001
From: Karl Hobley <karl@torchbox.com>
Date: Mon, 30 Jun 2014 13:34:37 +0100
Subject: [PATCH] Added basic documentation for management commands

---
 docs/management_commands.rst | 59 ++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 docs/management_commands.rst

diff --git a/docs/management_commands.rst b/docs/management_commands.rst
new file mode 100644
index 0000000000..e5f6393f7c
--- /dev/null
+++ b/docs/management_commands.rst
@@ -0,0 +1,59 @@
+Management commands
+===================
+
+publish_scheduled_pages
+-----------------------
+
+**./manage.py publish_scheduled_pages**
+
+This command publishes/unpublishes pages that have had these actions scheduled by an editor.
+
+It is recommended to run this command once an hour.
+
+
+fixtree
+-------
+
+**./manage.py fixtree**
+
+This command scans for errors in your database and attempts to fix any issues it finds.
+
+
+move_pages
+----------
+
+**./manage.py move_pages from to**
+
+This mass moves a bunch of pages from one section of the tree to another.
+
+Options:
+
+ - **from**
+  This is id of the page to move pages from. All descendants of this page will be moved to the destination. After the operation is complete, this page will have no children.
+
+ - **to**
+  This is the id of the page to move pages to.
+
+
+update_index
+------------
+
+**./manage.py update_index**
+
+This command rebuilds the search index from scratch. It is only required when using ElasticSearch.
+
+It is recommended to run this command once a week and at the following times:
+ - Whenever any pages have been created through a script (eg, import)
+ - Whenever any changes have been made to models or search configuration
+
+While this command is running, the search may not return any results so avoid running this command at peak times.
+
+
+search_garbage_collect
+----------------------
+
+**./manage.py search_garbage_collect**
+
+Wagtail keeps a log of search queries that are popular on your website. On high traffic websites, this log may get big and sometimes you may want to clean out old search queries.
+
+This command cleans out all search query logs that are more than one week old.