diff --git a/docs/index.rst b/docs/index.rst index a35560f824..5d2344b180 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,6 +20,7 @@ It supports Django 1.6.2+ on Python 2.6 and 2.7. Django 1.7 and Python 3 support deploying performance static_site_generation + management_commands contributing support roadmap diff --git a/docs/management_commands.rst b/docs/management_commands.rst index e5f6393f7c..3f77fc3eff 100644 --- a/docs/management_commands.rst +++ b/docs/management_commands.rst @@ -4,56 +4,49 @@ 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. +:code:`./manage.py publish_scheduled_pages` +This command publishes or 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** +:code:`./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** +:code:`manage.py move_pages from to` -This mass moves a bunch of pages from one section of the tree to another. +This command moves a selection 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. + This is the **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. - + This is the **id** of the page to move pages to. update_index ------------ -**./manage.py update_index** +:code:`./manage.py update_index` -This command rebuilds the search index from scratch. It is only required when using ElasticSearch. +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. + - whenever any pages have been created through a script (after an import, for example) + - whenever any changes have been made to models or search configuration +The search may not return any results while this command is running, so avoid running it at peak times. search_garbage_collect ---------------------- -**./manage.py search_garbage_collect** +:code:`./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. +Wagtail keeps a log of search queries that are popular on your website. On high traffic websites, this log may get big and you may want to clean out old search queries. This command cleans out all search query logs that are more than one week old.