]> git.ipfire.org Git - thirdparty/bugzilla.git/commitdiff
WIP
authorGervase Markham <gerv@gerv.net>
Mon, 15 Sep 2014 11:29:04 +0000 (19:29 +0800)
committerGervase Markham <gerv@gerv.net>
Mon, 15 Sep 2014 11:29:04 +0000 (19:29 +0800)
docs/en/rst/extensions/example.rst [deleted file]
extensions/Voting/doc/voting.rst [new file with mode: 0644]

diff --git a/docs/en/rst/extensions/example.rst b/docs/en/rst/extensions/example.rst
deleted file mode 100644 (file)
index 07b3558..0000000
+++ /dev/null
@@ -1,22 +0,0 @@
-Example
-#######
-
-This is a sample documentation file for the Example extension. Like all of
-the Bugzilla docs, it's written in
-`reStructured Text (reST) format <http://sphinx-doc.org/latest/rest.html>`_
-and will be compiled by `Sphinx <http://sphinx-doc.org/>`_.
-
-If you build the docs yourself using :file:`makedocs.pl`, this file will get
-incorporated into the Extensions chapter, as will any documentation
-you write for your extensions which fulfils the following criteria:
-
-* In the :file:`extensions/YourExtension/doc/` directory
-* Has a :file:`.rst` file extension
-
-You are recommended to make the name of your reST doc file the same as the
-name of your extension, so that there is no clash when all the extension
-documentation is copied into the same directory. So, for example, this file
-is called :file:`example.rst`, as it's part of the Example extension. If you
-need multiple documentation files, prefix the filename with the name of your
-extension, e.g. :file:`example-extra.rst`.
diff --git a/extensions/Voting/doc/voting.rst b/extensions/Voting/doc/voting.rst
new file mode 100644 (file)
index 0000000..d114a45
--- /dev/null
@@ -0,0 +1,34 @@
+.. _voting:
+
+Voting
+######
+
+To enable the Voting exteion, you must remove the :file:`disabled`
+file from the directory :file:`extensions/Voting/`, and run
+:file:`checksetup.pl`.
+
+Voting allows users to be given a pot of votes which they can allocate
+to bugs, to indicate that they'd like them fixed.
+This allows developers to gauge
+user need for a particular enhancement or bugfix. By allowing bugs with
+a certain number of votes to automatically move from "UNCONFIRMED" to
+"CONFIRMED", users of the bug system can help high-priority bugs garner
+attention so they don't sit for a long time awaiting triage.
+
+To modify Voting settings, navigate to the "Edit product" screen for the
+Product you wish to modify. The following settings are available:
+
+*Maximum votes per person:*
+    Setting this field to "0" disables voting.
+
+*Maximum votes a person can put on a single bug:*
+    It should probably be some number lower than the
+    "Maximum votes per person". Don't set this field to "0" if
+    "Maximum votes per person" is non-zero; that doesn't make
+    any sense.
+
+*Number of votes a bug in this product needs to automatically get out of the UNCONFIRMED state:*
+    Setting this field to "0" disables the automatic move of
+    bugs from UNCONFIRMED to CONFIRMED.
+
+Once you have adjusted the values to your preference, click "Update".