summaryrefslogtreecommitdiff
path: root/doc/user/project/labels.md
diff options
context:
space:
mode:
authorVictor Wu <victor@gitlab.com>2017-11-07 09:12:14 +0000
committerSean McGivern <sean@mcgivern.me.uk>2017-11-07 09:12:14 +0000
commit12dbf5555373863e397a51a51957632054b58073 (patch)
tree3e982872f2c59565e8e410ba4013a4a6ee39e8a4 /doc/user/project/labels.md
parent61b775edcc5d710055c089aa71898bc01592edaf (diff)
downloadgitlab-ce-12dbf5555373863e397a51a51957632054b58073.tar.gz
Label priority and Priority sort orders
Diffstat (limited to 'doc/user/project/labels.md')
-rw-r--r--doc/user/project/labels.md29
1 files changed, 23 insertions, 6 deletions
diff --git a/doc/user/project/labels.md b/doc/user/project/labels.md
index 21a2e1213ec..d7eb4bca89c 100644
--- a/doc/user/project/labels.md
+++ b/doc/user/project/labels.md
@@ -77,15 +77,32 @@ having their priority set to null.
![Prioritize labels](img/labels_prioritize.png)
-Now that you have labels prioritized, you can use the 'Priority' and 'Label
-priority' filters in the issues or merge requests tracker.
+Now that you have labels prioritized, you can use the 'Label priority' and 'Priority'
+sort orders in the issues or merge requests tracker.
-The 'Label priority' filter puts issues with the highest priority label on top.
+In the following, everything applies to both issues and merge requests, but we'll
+refer to just issues for brevity.
-The 'Priority' filter sorts issues by their soonest milestone due date, then by
-label priority.
+The 'Label priority' sort order positions issues with higher priority labels
+toward the top, and issues with lower priority labels toward the bottom. A non-prioritized
+label is considered to have the lowest priority. For a given issue, we _only_ consider the
+highest priority label assigned to it in the comparison. ([We are discussing](https://gitlab.com/gitlab-org/gitlab-ce/issues/18554)
+including all the labels in a given issue for this comparison.) Given two issues
+are equal according to this sort comparison, their relative order is equal, and
+therefore it's not guaranteed that one will be always above the other.
+
+![Label priority sort order](img/label_priority_sort_order.png)
+
+The 'Priority' sort order comparison first considers an issue's milestone's due date,
+(if the issue is assigned a milestone and the milestone's due date exists), and then
+secondarily considers the label priority comparison above. Sooner due dates results
+a higher sort order. If an issue doesn't have a milestone due date, it is equivalent to
+being assigned to a milestone that has a due date in the infinite future. Given two issues
+are equal according to this two-stage sort comparison, their relative order is equal, and
+therefore it's not guaranteed that one will be always above the other.
+
+![Priority sort order](img/priority_sort_order.png)
-![Filter labels by priority](img/labels_filter_by_priority.png)
## Subscribe to labels