From 498f4f4627e3944c66ff663a71f4f85f61171431 Mon Sep 17 00:00:00 2001 From: Matt Westcott Date: Tue, 21 Feb 2017 10:57:25 +0000 Subject: [PATCH] Add note that promoted search results are an optional feature (#3343) Addresses #3321 --- .../administrator_tasks/promoted_search_results.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/editor_manual/administrator_tasks/promoted_search_results.rst b/docs/editor_manual/administrator_tasks/promoted_search_results.rst index 8ceb3c6832..618524653c 100644 --- a/docs/editor_manual/administrator_tasks/promoted_search_results.rst +++ b/docs/editor_manual/administrator_tasks/promoted_search_results.rst @@ -1,6 +1,10 @@ Promoted search results ======================= +.. Note:: + Promoted search results are an optional Wagtail feature. For details of how to enable them on a Wagtail installation, see :mod:`~wagtail.contrib.wagtailsearchpromotions` + + 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.