diff --git a/docs/_static/images/screen35_users_menu_item.png b/docs/_static/images/screen35_users_menu_item.png new file mode 100644 index 0000000000..991f33938a Binary files /dev/null and b/docs/_static/images/screen35_users_menu_item.png differ diff --git a/docs/_static/images/screen36_users_interface.png b/docs/_static/images/screen36_users_interface.png new file mode 100644 index 0000000000..30ca39ffeb Binary files /dev/null and b/docs/_static/images/screen36_users_interface.png differ diff --git a/docs/_static/images/screen37_promoted_menu_item.png b/docs/_static/images/screen37_promoted_menu_item.png new file mode 100644 index 0000000000..015a380bd4 Binary files /dev/null and b/docs/_static/images/screen37_promoted_menu_item.png differ diff --git a/docs/_static/images/screen38.5_popular_search_results.png b/docs/_static/images/screen38.5_popular_search_results.png new file mode 100644 index 0000000000..c4d32a8d80 Binary files /dev/null and b/docs/_static/images/screen38.5_popular_search_results.png differ diff --git a/docs/_static/images/screen38_promoted_results_listing.png b/docs/_static/images/screen38_promoted_results_listing.png new file mode 100644 index 0000000000..532b3d1a5d Binary files /dev/null and b/docs/_static/images/screen38_promoted_results_listing.png differ diff --git a/docs/_static/images/screen39_add_promoted_result.png b/docs/_static/images/screen39_add_promoted_result.png new file mode 100644 index 0000000000..9a17cbfde2 Binary files /dev/null and b/docs/_static/images/screen39_add_promoted_result.png differ diff --git a/docs/editor_manual/administrator_tasks/index.rst b/docs/editor_manual/administrator_tasks/index.rst new file mode 100644 index 0000000000..e4d82c0d86 --- /dev/null +++ b/docs/editor_manual/administrator_tasks/index.rst @@ -0,0 +1,11 @@ +Administrator tasks +=================== + +This section of the guide documents how to perform common tasks as an administrator of a Wagtail site. + +.. toctree:: + :maxdepth: 3 + + managing_users + promoted_search_results + .. redirects diff --git a/docs/editor_manual/administrator_tasks/managing_users.rst b/docs/editor_manual/administrator_tasks/managing_users.rst new file mode 100644 index 0000000000..d3abda84c8 --- /dev/null +++ b/docs/editor_manual/administrator_tasks/managing_users.rst @@ -0,0 +1,32 @@ +Managing users and roles +======================== + +As an administrator, a common task will be adding, modifying or removing user profiles. + +This is done via the 'Users' interface, which can be found in the Settings menu, accessible via the left-hand menu bar. + +.. image:: ../../_static/images/screen35_users_menu_item.png + +In this interface you can see all of your users, their usernames, their 'level' of access (otherwise known as their 'role'), and their status, either active or inactive. + +You can sort this listing either via Name or Username. + +.. image:: ../../_static/images/screen36_users_interface.png + +Clicking on a user's name will open their profile details. From here you can then edit that users details. + +.. Note:: + It is possible to change user's passwords in this interface, but it is worth encouraging your users to use the 'Forgotten password' link on the login screen instead. This should save you some time! + +Click the 'Roles' tab to edit the level of access your users have. By default there are three roles: + ++--------------+--------------+-----------------+-----------------+ +| Role | Create drafts| Publish content | Access Settings | ++==============+==============+=================+=================+ +| Editor | Yes | No | No | ++--------------+--------------+-----------------+-----------------+ +| Moderator | Yes | Yes | No | ++--------------+--------------+-----------------+-----------------+ +| Administrator| Yes | Yes | Yes | ++--------------+--------------+-----------------+-----------------+ + diff --git a/docs/editor_manual/administrator_tasks/promoted_search_results.rst b/docs/editor_manual/administrator_tasks/promoted_search_results.rst new file mode 100644 index 0000000000..8ceb3c6832 --- /dev/null +++ b/docs/editor_manual/administrator_tasks/promoted_search_results.rst @@ -0,0 +1,25 @@ +Promoted search results +======================= + +Wagtail allows you to promote certain search results dependant on the keyword or phrase entered by the user when searching. This can be particularly useful when users commonly refer to parts of your organisation via an acronym that isn't in official use, or if you want to direct users to a page that when they enter a certain term related to the page but not included in the text of the page itself. + +As a concrete example, one of our clients wanted to direct people who searched for 'finances' to their 'Annual budget review' page. The word 'finances' is not mentioned in either the title or the body of the target page. So they created a promoted search result for the word 'finances' that pushed the budget page to the very top of the results. + +.. Note:: + The promoted result will only work if the user types *exactly* the phrase that you have set it up for. If you have variations of phrase that you want to take into account, then you must create additional promoted results. + +To set up the promoted search results, click on the 'Promoted search results' menu item in the 'Settings' menu. + +.. image:: ../../_static/images/screen37_promoted_menu_item.png + +Add a new promoted result from the button in the top right of the resulting screen, or edit an existing promoted result by clicking on it. + +.. image:: ../../_static/images/screen38_promoted_results_listing.png + +When adding a new promoted result, Wagtail provides you with a 'Choose from popular search terms' option. This will show you the most popular terms entered by users into your internal search. You can match this against your existing promoted results to ensure that users are able to find what they are looking for. + +.. image:: ../../_static/images/screen38.5_popular_search_results.png + +You then add a the result itself by clicking 'Add recommended page'. You can add multiple results, but be careful about adding too many, as you may end up hiding all of your organic results with promoted results, which may not be helpful for users who aren't really sure what they are looking for. + +.. image:: ../../_static/images/screen39_add_promoted_result.png diff --git a/docs/editor_manual/getting_started.rst b/docs/editor_manual/getting_started.rst index ffa6931fd9..2231989ba2 100644 --- a/docs/editor_manual/getting_started.rst +++ b/docs/editor_manual/getting_started.rst @@ -4,7 +4,7 @@ Getting started The Wagtail demo site _____________________ -This examples in this document are based on the `Wagtail demo site `_. However, the instructions are general enough as to be applicable to any Wagtail site. If you want to use the demo site you can find installation and launch instructions on its `Github `_ page. +This examples in this document are based on `Torchbox.com `_. However, the instructions are general enough as to be applicable to any Wagtail site. For the purposes of this documentation we will be using the URL, **www.example.com**, to represent the root (homepage) of your website. diff --git a/docs/editor_manual/index.rst b/docs/editor_manual/index.rst index 72fb32b916..de7423e243 100644 --- a/docs/editor_manual/index.rst +++ b/docs/editor_manual/index.rst @@ -14,3 +14,4 @@ This section of the documentation is written for the users of a Wagtail-powered new_pages/index editing_existing_pages documents_images_snippets/index + administrator_tasks/index diff --git a/docs/editor_manual/new_pages/index.rst b/docs/editor_manual/new_pages/index.rst index 904b94600b..75fc237279 100644 --- a/docs/editor_manual/new_pages/index.rst +++ b/docs/editor_manual/new_pages/index.rst @@ -3,7 +3,7 @@ Creating new pages .. image:: ../../_static/images/screen08_add_page_button.png -Create new pages by clicking the Add child page. This creates a child page of the section you are currently in. In this case a child page of the Homepage. +Create new pages by clicking the **Add child page** button. This creates a child page of the section you are currently in. In this case a child page of the 'School of Fine Art' page. .. ADD IN OTHER WAYS A CHILD PAGE CAN BE ADDED?>>