From 44d00020eeedc30113c3e083465e9dfc742b0da9 Mon Sep 17 00:00:00 2001 From: Kadir Topal Date: Mon, 2 Sep 2013 18:59:17 +0200 Subject: [PATCH] Adding documenting for AAQ search and questions states --- docs/index.rst | 1 + docs/questions.rst | 47 ++++++++++++++++++++++++++++++++++++++++++ docs/searchchapter.rst | 8 +++++++ 3 files changed, 56 insertions(+) create mode 100644 docs/questions.rst diff --git a/docs/index.rst b/docs/index.rst index 65aa3c4c4..a97eb1bb5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -58,6 +58,7 @@ Part 4: Administration products groups users + questions forums badges diff --git a/docs/questions.rst b/docs/questions.rst new file mode 100644 index 000000000..a6f9c6e47 --- /dev/null +++ b/docs/questions.rst @@ -0,0 +1,47 @@ +====== +Questions +====== + +This document explains what kinds of question states exist in Kitsune, +how they are set and their implications. + +Question States +=============== + +Not yet posted +-------------- +Questions are created within the `Ask a question` workflow, +but they are not shown in question listings until the user is confirmed. + + +Default +------- +This is the unmarked state of the thread. + +Implications: +1. Users can reply +2. Visible in regular SUMO searches (with at least one helpful reply) +3. Visible to external searches +4. Visible in the regular questions list +5. Visible in the `related threads` section + + +Locked +------ +This is the locked state of a thread. A thread can be locked in two ways: +1. By manually locking it via the question UI +2. Automatically after 180 days. + +Implications: +1. Users can't reply +2. Moderators can reply +3. If there is an answer, the locked thread is still shown by search +engines and our internal search. +4. If there is no answer, the locked thread will not be shown by search +engines and our internal search. + + +Not indexed +----------- +Questions with no answers that are older than 30 days have a meta tag telling + search engines not to show them. diff --git a/docs/searchchapter.rst b/docs/searchchapter.rst index afe9c36d3..54cd43f6b 100644 --- a/docs/searchchapter.rst +++ b/docs/searchchapter.rst @@ -337,6 +337,14 @@ Regular search does the following: It scores as specified above. +Ask A Question search +---------- + +An `Ask a question` or `AAQ` search is any search that is performed within +the AAQ workflow. The only difference to `regular` search is that `AAQ` +search shows forum posts that have no answer marked as helpful. + + Advanced search ---------------