diff options
author | Marcel Amirault <mamirault@gitlab.com> | 2019-07-31 15:54:36 +0900 |
---|---|---|
committer | Marcel Amirault <mamirault@gitlab.com> | 2019-07-31 15:54:36 +0900 |
commit | b6c337bb2810d8390f4cd0f813bb412043e2c6fe (patch) | |
tree | a61c46fa1fcdca6c53d334d452690072004aae81 | |
parent | fc631c95008f70acd8371042a20a32013aaa8adf (diff) | |
download | gitlab-ce-docs-labels-update.tar.gz |
Improve labels doc with more suggestionsdocs-labels-update
Capitalization and list adjustments, and simplifications
to the labels doc
-rw-r--r-- | doc/user/project/labels.md | 61 |
1 files changed, 35 insertions, 26 deletions
diff --git a/doc/user/project/labels.md b/doc/user/project/labels.md index 50fcc77b956..a00c1c980d2 100644 --- a/doc/user/project/labels.md +++ b/doc/user/project/labels.md @@ -93,9 +93,8 @@ GitLab will add the following default labels to the project: To create a **group label**, navigate to **Issues > Labels** in the **group** and create it from there. This page only shows group labels in this group. -Alternatively, you can create group labels from the Epic sidebar. **(ULTIMATE)** -Please note that the created label will belong to the immediate group to which the -epic belongs. +Alternatively, you can create group labels from the Epic sidebar. Please note that the +created label will belong to the immediate group to which the epic belongs. **(ULTIMATE)** ![Create Labels from Epic](img/labels_epic_sidebar_v12_1.png) @@ -141,9 +140,13 @@ action cannot be reversed and the changes are permanent. ## Assigning labels from the sidebar Every issue and merge request can be assigned any number of labels. The labels are -visible on every issue and merge request page, in the sidebar. They are also visible -in the issue board. From the sidebar, you can assign or unassign a label to the object -(i.e. label or unlabel it). You can also perform this as a [quick action](quick_actions.md), +visible on every issue and merge request page, in the sidebar. They are also visible on: + +- Every issue and merge request page in the sidebar. +- The issue board. + +From the sidebar, you can assign or unassign a label to the object (i.e. label or +unlabel it). You can also perform this as a [quick action](quick_actions.md), in a comment. | View labels in sidebar | Assign labels from sidebar | @@ -161,25 +164,29 @@ GitLab will check both the label titles and descriptions for the search. ## Filtering by label -Issue, merge request, and epic **(ULTIMATE)** lists, as well as issue boards, can -be filtered by labels. +The following can be filtered labels: + +- Issue lists +- Merge Request lists +- Epic lists **(ULTIMATE)** +- Issue Boards ### Filtering in list pages - From the project issue list page and the project merge request list page, you can [filter](../search/index.md#issues-and-merge-requests) by: - - group labels (including subgroup ancestors) - - project labels + - Group labels (including subgroup ancestors) + - Project labels - From the group issue list page and the group merge request list page, you can [filter](../search/index.md#issues-and-merge-requests) by: - - group labels (including subgroup ancestors and subgroup descendants) - - project labels + - Group labels (including subgroup ancestors and subgroup descendants) + - Project labels -- From the group epic list page **(ULTIMATE)**, you can [filter](../search/index.md#issues-and-merge-requests) - by: - - current group labels - - descendant group labels +- You can [filter](../search/index.md#issues-and-merge-requests) the group epic list + page by: **(ULTIMATE)** + - Current group labels + - Descendant group labels ![Labels group issues](img/labels_group_issues_v12_1.png) @@ -187,16 +194,16 @@ be filtered by labels. - From [project boards](issue_board.md), you can use the [search and filter bar](../search/index.md#issue-boards) to filter by: - - group labels - - project labels + - Group labels + - Project labels - From [group issue boards](issue_board.md#group-issue-boards-premium), you can use the [search and filter bar](../search/index.md#issue-boards) to filter by group labels only. **(PREMIUM)** - From [project boards](issue_board.md), in the [issue board configuration](issue_board.md#configurable-issue-boards-starter), you can filter by: **(STARTER)** - - group labels - - project labels + - Group labels + - Project labels - From [group issue boards](issue_board.md#group-issue-boards-premium), in the [issue board configuration](issue_board.md#configurable-issue-boards-starter), you can filter by group labels only. **(STARTER)** @@ -216,8 +223,8 @@ that the label has been assigned to an issue or merge request. > - Introduced in GitLab 8.9. > - Priority sorting is based on the highest priority label only. [This discussion](https://gitlab.com/gitlab-org/gitlab-ce/issues/18554) considers changing this. -Labels can have relative priorities, which are used in the **Label priority** and -**Priority** sort orders of the issue and merge request list pages. +Labels can have relative priorities, which are used in the "Label priority" and +"Priority" sort orders of the issue and merge request list pages. From the project label list page, star a label to indicate that it has a priority. @@ -225,7 +232,9 @@ From the project label list page, star a label to indicate that it has a priorit Drag starred labels up and down the list to change their priority. Higher in the list means higher priority. Prioritization happens at the project level, only on the project -label list page, and not on the group label list page. However, both project and group +label list page, and not on the group label list page. + +However, both project and group labels can be prioritized on the project label list page since both types are displayed on the project label list page. @@ -240,15 +249,15 @@ If you sort by `Label priority`, GitLab considers this sort comparison order: - Object with a higher priority prioritized label. - Object without a prioritized label. -Ties are broken arbitrarily. (Note that we _only_ consider the highest prioritized label +Ties are broken arbitrarily. Note that we _only_ consider the highest prioritized label in an object, and not any of the lower prioritized labels. [This discussion](https://gitlab.com/gitlab-org/gitlab-ce/issues/18554) -considers changing this.) +considers changing this. ![Labels sort label priority](img/labels_sort_label_priority.png) If you sort by `Priority`, GitLab considers this sort comparison order: -- Object's assigned [milestone](milestones/index.md)'s due date is sooner, provided +- Due date of the assigned [milestone](milestones/index.md) is sooner, provided the object has a milestone and the milestone has a due date. If this isn't the case, consider the object having a due date in the infinite future. - Object with a higher priority prioritized label. |