From: lpsolit%gmail.com <>
Date: Wed, 22 Nov 2006 07:43:02 +0000 (+0000)
Subject: Docs for bug 281876: There is now a UI to edit legal values - Patch by me, r=justdave
X-Git-Tag: bugzilla-2.20.4~13
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f35a03d7cc974c222c3e4e0f14b88b02f59de126;p=thirdparty%2Fbugzilla.git

Docs for bug 281876: There is now a UI to edit legal values - Patch by me, r=justdave
---

diff --git a/docs/xml/administration.xml b/docs/xml/administration.xml
index 416cbfd4ee..5ad3e56772 100644
--- a/docs/xml/administration.xml
+++ b/docs/xml/administration.xml
@@ -1178,7 +1178,56 @@
     <!-- XXX We should add a "Uses of Flags" section, here, with examples. -->
 
   </section> <!-- flags -->
-   
+
+  <section id="edit-values">
+    <title>Legal Values</title>
+
+    <para>
+      Since Bugzilla 2.20 RC1, legal values for Operating Systems, platforms,
+      bug priorities and severities can be edited from the User Interface
+      directly. This means that it is no longer required to manually edit
+      <filename>localconfig</filename>.
+    </para>
+
+    <section id="edit-values-list">
+      <title>Viewing/Editing legal values</title>
+      <para>
+        Editing legal values requires <quote>editcomponents</quote> privileges.
+        A link named <quote>Field Values</quote> is visible in your footer and
+        clicking on it displays the list of fields whose values can be edited.
+      </para>
+      <para>
+	You can add as many legal values as you want, and each value must be
+	unique (on a per field basis). The sortkey is important to display these
+	values in the desired order.
+      </para>
+    </section>
+
+    <section id="edit-values-delete">
+      <title>Deleting legal values</title>
+      <para>
+        You can also delete legal values, but only if the two following conditions
+	are respected:
+      </para>
+
+      <orderedlist>
+        <listitem>
+	  <para>The value is not used by default for the field.</para>
+	</listitem>
+
+	<listitem>
+	  <para>No bug is currently using this value.</para>
+        </listitem>
+      </orderedlist>
+
+      <para>
+        If any of these conditions is not respected, the value cannot be deleted.
+	The only way to delete these values is to reassign bugs to another value
+	and to set another value as default for the field.
+      </para>
+    </section>
+  </section>
+
   <section id="voting">
     <title>Voting</title>