Merge branch 'doc_refactor_labels' into 'master'
Refactor labels docs Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/18555 See merge request !3347
|
@ -12,7 +12,7 @@ Create projects and groups.
|
|||
Create issues, labels, milestones, cast your vote, and review issues.
|
||||
|
||||
- [Create a new issue](../gitlab-basics/create-issue.md)
|
||||
- [Assign labels to issues](../workflow/labels.md)
|
||||
- [Assign labels to issues](../user/project/labels.md)
|
||||
- [Use milestones as an overview of your project's tracker](../workflow/milestones.md)
|
||||
- [Use voting to express your like/dislike to issues and merge requests](../workflow/award_emoji.md)
|
||||
|
||||
|
|
After Width: | Height: | Size: 30 KiB |
After Width: | Height: | Size: 31 KiB |
After Width: | Height: | Size: 28 KiB |
After Width: | Height: | Size: 78 KiB |
After Width: | Height: | Size: 22 KiB |
After Width: | Height: | Size: 80 KiB |
After Width: | Height: | Size: 59 KiB |
After Width: | Height: | Size: 31 KiB |
After Width: | Height: | Size: 42 KiB |
After Width: | Height: | Size: 10 KiB |
After Width: | Height: | Size: 16 KiB |
After Width: | Height: | Size: 106 KiB |
After Width: | Height: | Size: 11 KiB |
|
@ -0,0 +1,147 @@
|
|||
# Labels
|
||||
|
||||
Labels provide an easy way to categorize the issues or merge requests based on
|
||||
descriptive titles like `bug`, `documentation` or any other text you feel like
|
||||
it. They can have different colors, a description, and are visible throughout
|
||||
the issue tracker or inside each issue individually.
|
||||
|
||||
With labels, you can navigate the issue tracker and filter any bloated
|
||||
information to visualize only the issues you are interested in. Let's see how
|
||||
that works.
|
||||
|
||||
## Create new labels
|
||||
|
||||
>**Note:**
|
||||
A permission level of `Developer` or higher is required in order to manage
|
||||
labels.
|
||||
|
||||
Head over a single project and navigate to **Issues > Labels**.
|
||||
|
||||
The first time you visit this page, you'll notice that there are no labels
|
||||
created yet.
|
||||
|
||||
![Generate new labels](img/labels_generate.png)
|
||||
|
||||
---
|
||||
|
||||
You can skip that and create a new label or click that link and GitLab will
|
||||
generate a set of predefined labels for you. There 8 default generated labels
|
||||
in total and you can see them in the screenshot below.
|
||||
|
||||
![Default generated labels](img/labels_default.png)
|
||||
|
||||
---
|
||||
|
||||
You can see that from the labels page you can have an overview of the number of
|
||||
issues and merge requests assigned to each label.
|
||||
|
||||
Creating a new label from scratch is as easy as pressing the **New label**
|
||||
button. From there on you can choose the name, give it an optional description,
|
||||
a color and you are set.
|
||||
|
||||
When you are ready press the **Create label** button to create the new label.
|
||||
|
||||
![New label](img/labels_new_label.png)
|
||||
|
||||
## Prioritize labels
|
||||
|
||||
>**Notes:**
|
||||
- This feature was introduced in GitLab 8.9.
|
||||
- Priority sorting is based on the highest priority label only. This might
|
||||
change in the future, follow the discussion in
|
||||
https://gitlab.com/gitlab-org/gitlab-ce/issues/18554.
|
||||
|
||||
Prioritized labels are like any other label, but sorted by priority. This allows
|
||||
you to sort issues and merge requests by priority.
|
||||
|
||||
To prioritize labels, navigate to your project's **Issues > Labels** and click
|
||||
on the star icon next to them to put them in the priority list. Click on the
|
||||
star icon again to remove them from the list.
|
||||
|
||||
From there, you can drag them around to set the desired priority. Priority is
|
||||
set from high to low with an ascending order. Labels with no priority, count as
|
||||
having their priority set to null.
|
||||
|
||||
![Prioritize labels](img/labels_prioritize.png)
|
||||
|
||||
Now that you have labels prioritized, you can use the 'Priority' filter in the
|
||||
issues or merge requests tracker. Those with the highest priority label, will
|
||||
appear on top.
|
||||
|
||||
![Filter labels by priority](img/labels_filter_by_priority.png)
|
||||
|
||||
## Subscribe to labels
|
||||
|
||||
If you don’t want to miss issues or merge requests that are important to you,
|
||||
simply subscribe to a label. You’ll get notified whenever the label gets added
|
||||
to an issue or merge request, making sure you don’t miss a thing.
|
||||
|
||||
Go to your project's **Issues > Labels** area, find the label(s) you want to
|
||||
subscribe to and click on the eye icon. Click again to unsubscribe.
|
||||
|
||||
![Subscribe to labels](img/labels_subscribe.png)
|
||||
|
||||
If you work on a large or popular project, try subscribing only to the labels
|
||||
that are relevant to you. You’ll notice it’ll be much easier to focus on what’s
|
||||
important.
|
||||
|
||||
## Create a new label right from the issue tracker
|
||||
|
||||
>**Note:**
|
||||
This feature was introduced in GitLab 8.6.
|
||||
|
||||
There are times when you are already in the issue tracker searching for a
|
||||
label, only to realize it doesn't exist. Instead of going to the **Labels**
|
||||
page and being distracted from your original purpose, you can create new
|
||||
labels on the fly.
|
||||
|
||||
Select **Create new** from the labels dropdown list, provide a name, pick a
|
||||
color and hit **Create**.
|
||||
|
||||
![Create new label on the fly](img/labels_new_label_on_the_fly_create.png)
|
||||
![New label on the fly](img/labels_new_label_on_the_fly.png)
|
||||
|
||||
## Assigning labels to issues and merge requests
|
||||
|
||||
There are generally two ways to assign a label to an issue or merge request.
|
||||
|
||||
You can assign a label when you first create or edit an issue or merge request.
|
||||
|
||||
![Assign label in new issue](img/labels_assign_label_in_new_issue.png)
|
||||
|
||||
---
|
||||
|
||||
The second way is by using the right sidebar when inside an issue or merge
|
||||
request. Expand it and hit **Edit** in the labels area. Start typing the name
|
||||
of the label you are looking for to narrow down the list, and select it. You
|
||||
can add more than one labels at once. When done, click outside the sidebar area
|
||||
for the changes to take effect.
|
||||
|
||||
![Assign label in sidebar](img/labels_assign_label_sidebar.png)
|
||||
![Save labels in sidebar](img/labels_assign_label_sidebar_saved.png)
|
||||
|
||||
---
|
||||
|
||||
To remove labels, expand the left sidebar and unmark them from the labels list.
|
||||
Simple as that.
|
||||
|
||||
## Use labels to filter issues
|
||||
|
||||
Once you start adding labels to your issues, you'll see the benefit of it.
|
||||
Labels can have several uses, one of them being the quick filtering of issues
|
||||
or merge requests.
|
||||
|
||||
Pick an existing label from the dropdown _Label_ menu or click on an existing
|
||||
label from the issue tracker. In the latter case, you also get to see the
|
||||
label description like shown below.
|
||||
|
||||
![Filter labels](img/labels_filter.png)
|
||||
|
||||
---
|
||||
|
||||
And if you added a description to your label, you can see it by hovering your
|
||||
mouse over the label in the issue tracker or wherever else the label is
|
||||
rendered.
|
||||
|
||||
![Label tooltips](img/labels_description_tooltip.png)
|
||||
|
|
@ -7,7 +7,7 @@
|
|||
- [Groups](groups.md)
|
||||
- [Keyboard shortcuts](shortcuts.md)
|
||||
- [File finder](file_finder.md)
|
||||
- [Labels](labels.md)
|
||||
- [Labels](../user/project/labels.md)
|
||||
- [Notification emails](notifications.md)
|
||||
- [Project Features](project_features.md)
|
||||
- [Project forking workflow](forking_workflow.md)
|
||||
|
|
|
@ -1,18 +1,3 @@
|
|||
# Labels
|
||||
|
||||
In GitLab, you can easily tag issues and Merge Requests. If you have permission level `Developer` or higher, you can manage labels. To create, edit or delete a label, go to a project and then to `Issues` and then `Labels`.
|
||||
|
||||
Here you can create a new label.
|
||||
|
||||
![new label](labels/label1.png)
|
||||
|
||||
You can choose to set a color.
|
||||
|
||||
![label color](labels/label2.png)
|
||||
|
||||
If you want to change an existing label, press edit next to the listed label.
|
||||
You will be presented with the same form as when creating a new label.
|
||||
|
||||
![edit label](labels/label3.png)
|
||||
|
||||
You can add labels to Merge Requests when you create or edit them.
|
||||
This document was moved to [user/project/labels.md](../user/project/labels.md).
|
||||
|
|
Before Width: | Height: | Size: 5.7 KiB |
Before Width: | Height: | Size: 16 KiB |
Before Width: | Height: | Size: 19 KiB |