Bug 403397: Missing documentation about keywords - Patch by Sam Folk-Williams <sam.folkwilliams@gmail.com> r=Colin

1 files changed, 24 insertions, 0 deletions

diff --git a/docs/en/xml/administration.xml b/docs/en/xml/administration.xml
index 83f88630e..5ece531a5 100644
--- a/docs/en/xml/administration.xml
+++ b/docs/en/xml/administration.xml
@@ -1396,6 +1396,30 @@ foo: ENTRY, MANDATORY/MANDATORY, CANEDIT
 
   </section> <!-- flags -->
 
+  <section id="keywords">
+    <title>Keywords</title>
+
+    <para>
+    The administrator can define keywords which can be used to tag and
+    categorise bugs. For example, the keyword "regression" is commonly used.
+    A company might have a policy stating all regressions
+    must be fixed by the next release - this keyword can make tracking those
+    bugs much easier.
+    </para>
+    <para>
+    Keywords are global, rather than per-product. If the administrator changes
+    a keyword currently applied to any bugs, the keyword cache must be rebuilt
+    using the <xref linkend="sanitycheck"/> script. Currently keywords can not
+    be marked obsolete to prevent future usage.
+    </para>
+    <para>
+    Keywords can be created, edited or deleted by clicking the "Keywords"
+    link in the admin page. There are two fields for each keyword - the keyword
+    itself and a brief description. Once created, keywords can be selected
+    and applied to individual bugs in that bug's "Details" section.
+    </para>
+  </section>
+
   <section id="custom-fields">
     <title>Custom Fields</title>