summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-06-22 13:50:02 +0200
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-06-22 13:50:02 +0200
commit78186c68ffc1180086c669726e14f815fda552d5 (patch)
tree9156d81a54bf4456acd7de5f7247bebc8120cf28
parent8195deb8a6debe3aa5a8f0573d0768dd257f7305 (diff)
downloadgitlab-ce-78186c68ffc1180086c669726e14f815fda552d5.tar.gz
Refactor labels documentation
- Add new images to match the new UI - Document the new prioritize feature
-rw-r--r--doc/user/project/img/labels_assign_label_in_new_issue.pngbin26380 -> 31126 bytes
-rw-r--r--doc/user/project/img/labels_assign_label_sidebar.pngbin30137 -> 31537 bytes
-rw-r--r--doc/user/project/img/labels_assign_label_sidebar_saved.pngbin25488 -> 28396 bytes
-rw-r--r--doc/user/project/img/labels_default.pngbin58717 -> 80403 bytes
-rw-r--r--doc/user/project/img/labels_description_tooltip.pngbin39315 -> 22585 bytes
-rw-r--r--doc/user/project/img/labels_filter.pngbin86911 -> 81536 bytes
-rw-r--r--doc/user/project/img/labels_filter_by_priority.pngbin0 -> 60849 bytes
-rw-r--r--doc/user/project/img/labels_generate.pngbin29986 -> 31608 bytes
-rw-r--r--doc/user/project/img/labels_new_label.pngbin29671 -> 43265 bytes
-rw-r--r--doc/user/project/img/labels_new_label_on_the_fly.pngbin11586 -> 10416 bytes
-rw-r--r--doc/user/project/img/labels_new_label_on_the_fly_create.pngbin20604 -> 16151 bytes
-rw-r--r--doc/user/project/img/labels_prioritize.pngbin0 -> 108751 bytes
-rw-r--r--doc/user/project/img/labels_subscribe.pngbin50177 -> 11536 bytes
-rw-r--r--doc/user/project/labels.md82
14 files changed, 56 insertions, 26 deletions
diff --git a/doc/user/project/img/labels_assign_label_in_new_issue.png b/doc/user/project/img/labels_assign_label_in_new_issue.png
index 72bbf9a0594..e32a35f7cda 100644
--- a/doc/user/project/img/labels_assign_label_in_new_issue.png
+++ b/doc/user/project/img/labels_assign_label_in_new_issue.png
Binary files differ
diff --git a/doc/user/project/img/labels_assign_label_sidebar.png b/doc/user/project/img/labels_assign_label_sidebar.png
index ffbbf5b8d21..799443af889 100644
--- a/doc/user/project/img/labels_assign_label_sidebar.png
+++ b/doc/user/project/img/labels_assign_label_sidebar.png
Binary files differ
diff --git a/doc/user/project/img/labels_assign_label_sidebar_saved.png b/doc/user/project/img/labels_assign_label_sidebar_saved.png
index 2771b02735f..e7d8d69e60e 100644
--- a/doc/user/project/img/labels_assign_label_sidebar_saved.png
+++ b/doc/user/project/img/labels_assign_label_sidebar_saved.png
Binary files differ
diff --git a/doc/user/project/img/labels_default.png b/doc/user/project/img/labels_default.png
index 2d44eb4409b..ee0c9f889ad 100644
--- a/doc/user/project/img/labels_default.png
+++ b/doc/user/project/img/labels_default.png
Binary files differ
diff --git a/doc/user/project/img/labels_description_tooltip.png b/doc/user/project/img/labels_description_tooltip.png
index 887ef5f43a8..0d1e3e091fb 100644
--- a/doc/user/project/img/labels_description_tooltip.png
+++ b/doc/user/project/img/labels_description_tooltip.png
Binary files differ
diff --git a/doc/user/project/img/labels_filter.png b/doc/user/project/img/labels_filter.png
index 139b3b22e14..ed622be2d93 100644
--- a/doc/user/project/img/labels_filter.png
+++ b/doc/user/project/img/labels_filter.png
Binary files differ
diff --git a/doc/user/project/img/labels_filter_by_priority.png b/doc/user/project/img/labels_filter_by_priority.png
new file mode 100644
index 00000000000..c5a9e20919b
--- /dev/null
+++ b/doc/user/project/img/labels_filter_by_priority.png
Binary files differ
diff --git a/doc/user/project/img/labels_generate.png b/doc/user/project/img/labels_generate.png
index 78eff8525bf..9579be4e231 100644
--- a/doc/user/project/img/labels_generate.png
+++ b/doc/user/project/img/labels_generate.png
Binary files differ
diff --git a/doc/user/project/img/labels_new_label.png b/doc/user/project/img/labels_new_label.png
index 6dc4fe8ce20..a916d3dceb5 100644
--- a/doc/user/project/img/labels_new_label.png
+++ b/doc/user/project/img/labels_new_label.png
Binary files differ
diff --git a/doc/user/project/img/labels_new_label_on_the_fly.png b/doc/user/project/img/labels_new_label_on_the_fly.png
index 4559c56dbda..80cc434239e 100644
--- a/doc/user/project/img/labels_new_label_on_the_fly.png
+++ b/doc/user/project/img/labels_new_label_on_the_fly.png
Binary files differ
diff --git a/doc/user/project/img/labels_new_label_on_the_fly_create.png b/doc/user/project/img/labels_new_label_on_the_fly_create.png
index ee75bc6ec92..c41090945eb 100644
--- a/doc/user/project/img/labels_new_label_on_the_fly_create.png
+++ b/doc/user/project/img/labels_new_label_on_the_fly_create.png
Binary files differ
diff --git a/doc/user/project/img/labels_prioritize.png b/doc/user/project/img/labels_prioritize.png
new file mode 100644
index 00000000000..8dfe72cf826
--- /dev/null
+++ b/doc/user/project/img/labels_prioritize.png
Binary files differ
diff --git a/doc/user/project/img/labels_subscribe.png b/doc/user/project/img/labels_subscribe.png
index f3c1a1b67e2..ea3db2bc0cf 100644
--- a/doc/user/project/img/labels_subscribe.png
+++ b/doc/user/project/img/labels_subscribe.png
Binary files differ
diff --git a/doc/user/project/labels.md b/doc/user/project/labels.md
index 93a14e7b8d7..4258185b7d0 100644
--- a/doc/user/project/labels.md
+++ b/doc/user/project/labels.md
@@ -15,11 +15,10 @@ that works.
A permission level of `Developer` or higher is required in order to manage
labels.
-Head over a single project and navigate to the label page by clicking on
-**Labels** in the left sidebar.
+Head over a single project and navigate to **Issues > Labels**.
-The first time you visit the **Labels** page you'll notice that there are no
-labels created yet.
+The first time you visit this page, you'll notice that there are no labels
+created yet.
![Generate new labels](img/labels_generate.png)
@@ -44,6 +43,48 @@ 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:**
@@ -54,8 +95,8 @@ 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.
-Just hit **New Label** from the dropdown list, provide a name, pick a color
-and hit **Create**.
+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)
@@ -64,26 +105,25 @@ and hit **Create**.
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. Expand it and hit **Edit**. Start
-typing the name of the label you are looking for to narrow down the list and
-select it. Once done, click outside the sidebar area for the changes to take
-effect.
+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, follow the same procedure like when adding them and hit the
-little **x** mark next to each one.
+To remove labels, expand the left sidebar and unmark them from the labels list.
+Simple as that.
## Use labels to filter issues
@@ -100,18 +140,8 @@ label description like shown below.
---
And if you added a description to your label, you can see it by hovering your
-mouse over the label in the issue tracker.
+mouse over the label in the issue tracker or wherever else the label is
+rendered.
![Label tooltips](img/labels_description_tooltip.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.
-
-![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.