diff options
author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-06-21 18:54:30 +0200 |
---|---|---|
committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-06-21 18:54:30 +0200 |
commit | 8195deb8a6debe3aa5a8f0573d0768dd257f7305 (patch) | |
tree | efb8079f1f805ad9651a2bcadb273f646bb2fa78 | |
parent | 67d6d964299972e1fc8adc062fa7aed2c3fd6512 (diff) | |
download | gitlab-ce-8195deb8a6debe3aa5a8f0573d0768dd257f7305.tar.gz |
Move labels documentation to new locationdoc_refactor_labels
Due to https://gitlab.com/gitlab-org/gitlab-ce/issues/3349
-rw-r--r-- | doc/intro/README.md | 2 | ||||
-rw-r--r-- | doc/user/project/img/labels_assign_label_in_new_issue.png (renamed from doc/workflow/img/labels_assign_label_in_new_issue.png) | bin | 26380 -> 26380 bytes | |||
-rw-r--r-- | doc/user/project/img/labels_assign_label_sidebar.png (renamed from doc/workflow/img/labels_assign_label_sidebar.png) | bin | 30137 -> 30137 bytes | |||
-rw-r--r-- | doc/user/project/img/labels_assign_label_sidebar_saved.png (renamed from doc/workflow/img/labels_assign_label_sidebar_saved.png) | bin | 25488 -> 25488 bytes | |||
-rw-r--r-- | doc/user/project/img/labels_default.png (renamed from doc/workflow/img/labels_default.png) | bin | 58717 -> 58717 bytes | |||
-rw-r--r-- | doc/user/project/img/labels_description_tooltip.png (renamed from doc/workflow/img/labels_description_tooltip.png) | bin | 39315 -> 39315 bytes | |||
-rw-r--r-- | doc/user/project/img/labels_filter.png (renamed from doc/workflow/img/labels_filter.png) | bin | 86911 -> 86911 bytes | |||
-rw-r--r-- | doc/user/project/img/labels_generate.png (renamed from doc/workflow/img/labels_generate.png) | bin | 29986 -> 29986 bytes | |||
-rw-r--r-- | doc/user/project/img/labels_new_label.png (renamed from doc/workflow/img/labels_new_label.png) | bin | 29671 -> 29671 bytes | |||
-rw-r--r-- | doc/user/project/img/labels_new_label_on_the_fly.png (renamed from doc/workflow/img/labels_new_label_on_the_fly.png) | bin | 11586 -> 11586 bytes | |||
-rw-r--r-- | doc/user/project/img/labels_new_label_on_the_fly_create.png (renamed from doc/workflow/img/labels_new_label_on_the_fly_create.png) | bin | 20604 -> 20604 bytes | |||
-rw-r--r-- | doc/user/project/img/labels_subscribe.png (renamed from doc/workflow/img/labels_subscribe.png) | bin | 50177 -> 50177 bytes | |||
-rw-r--r-- | doc/user/project/labels.md | 117 | ||||
-rw-r--r-- | doc/workflow/README.md | 2 | ||||
-rw-r--r-- | doc/workflow/labels.md | 116 | ||||
-rw-r--r-- | doc/workflow/labels/label1.png | bin | 5846 -> 0 bytes | |||
-rw-r--r-- | doc/workflow/labels/label2.png | bin | 16931 -> 0 bytes | |||
-rw-r--r-- | doc/workflow/labels/label3.png | bin | 19360 -> 0 bytes |
18 files changed, 120 insertions, 117 deletions
diff --git a/doc/intro/README.md b/doc/intro/README.md index 382d10aaf40..1850031eb26 100644 --- a/doc/intro/README.md +++ b/doc/intro/README.md @@ -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) diff --git a/doc/workflow/img/labels_assign_label_in_new_issue.png b/doc/user/project/img/labels_assign_label_in_new_issue.png Binary files differindex 72bbf9a0594..72bbf9a0594 100644 --- a/doc/workflow/img/labels_assign_label_in_new_issue.png +++ b/doc/user/project/img/labels_assign_label_in_new_issue.png diff --git a/doc/workflow/img/labels_assign_label_sidebar.png b/doc/user/project/img/labels_assign_label_sidebar.png Binary files differindex ffbbf5b8d21..ffbbf5b8d21 100644 --- a/doc/workflow/img/labels_assign_label_sidebar.png +++ b/doc/user/project/img/labels_assign_label_sidebar.png diff --git a/doc/workflow/img/labels_assign_label_sidebar_saved.png b/doc/user/project/img/labels_assign_label_sidebar_saved.png Binary files differindex 2771b02735f..2771b02735f 100644 --- a/doc/workflow/img/labels_assign_label_sidebar_saved.png +++ b/doc/user/project/img/labels_assign_label_sidebar_saved.png diff --git a/doc/workflow/img/labels_default.png b/doc/user/project/img/labels_default.png Binary files differindex 2d44eb4409b..2d44eb4409b 100644 --- a/doc/workflow/img/labels_default.png +++ b/doc/user/project/img/labels_default.png diff --git a/doc/workflow/img/labels_description_tooltip.png b/doc/user/project/img/labels_description_tooltip.png Binary files differindex 887ef5f43a8..887ef5f43a8 100644 --- a/doc/workflow/img/labels_description_tooltip.png +++ b/doc/user/project/img/labels_description_tooltip.png diff --git a/doc/workflow/img/labels_filter.png b/doc/user/project/img/labels_filter.png Binary files differindex 139b3b22e14..139b3b22e14 100644 --- a/doc/workflow/img/labels_filter.png +++ b/doc/user/project/img/labels_filter.png diff --git a/doc/workflow/img/labels_generate.png b/doc/user/project/img/labels_generate.png Binary files differindex 78eff8525bf..78eff8525bf 100644 --- a/doc/workflow/img/labels_generate.png +++ b/doc/user/project/img/labels_generate.png diff --git a/doc/workflow/img/labels_new_label.png b/doc/user/project/img/labels_new_label.png Binary files differindex 6dc4fe8ce20..6dc4fe8ce20 100644 --- a/doc/workflow/img/labels_new_label.png +++ b/doc/user/project/img/labels_new_label.png diff --git a/doc/workflow/img/labels_new_label_on_the_fly.png b/doc/user/project/img/labels_new_label_on_the_fly.png Binary files differindex 4559c56dbda..4559c56dbda 100644 --- a/doc/workflow/img/labels_new_label_on_the_fly.png +++ b/doc/user/project/img/labels_new_label_on_the_fly.png diff --git a/doc/workflow/img/labels_new_label_on_the_fly_create.png b/doc/user/project/img/labels_new_label_on_the_fly_create.png Binary files differindex ee75bc6ec92..ee75bc6ec92 100644 --- a/doc/workflow/img/labels_new_label_on_the_fly_create.png +++ b/doc/user/project/img/labels_new_label_on_the_fly_create.png diff --git a/doc/workflow/img/labels_subscribe.png b/doc/user/project/img/labels_subscribe.png Binary files differindex f3c1a1b67e2..f3c1a1b67e2 100644 --- a/doc/workflow/img/labels_subscribe.png +++ b/doc/user/project/img/labels_subscribe.png diff --git a/doc/user/project/labels.md b/doc/user/project/labels.md new file mode 100644 index 00000000000..93a14e7b8d7 --- /dev/null +++ b/doc/user/project/labels.md @@ -0,0 +1,117 @@ +# 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 the label page by clicking on +**Labels** in the left sidebar. + +The first time you visit the **Labels** 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) + +## 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. + +Just hit **New Label** from the 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. 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. + +![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. + +## 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. + +![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. diff --git a/doc/workflow/README.md b/doc/workflow/README.md index 9efe41308dc..ddb2f7281b1 100644 --- a/doc/workflow/README.md +++ b/doc/workflow/README.md @@ -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) diff --git a/doc/workflow/labels.md b/doc/workflow/labels.md index 93a14e7b8d7..5c09891dfdd 100644 --- a/doc/workflow/labels.md +++ b/doc/workflow/labels.md @@ -1,117 +1,3 @@ # 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 the label page by clicking on -**Labels** in the left sidebar. - -The first time you visit the **Labels** 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) - -## 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. - -Just hit **New Label** from the 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. 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. - -![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. - -## 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. - -![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. +This document was moved to [user/project/labels.md](../user/project/labels.md). diff --git a/doc/workflow/labels/label1.png b/doc/workflow/labels/label1.png Binary files differdeleted file mode 100644 index cac661a34c8..00000000000 --- a/doc/workflow/labels/label1.png +++ /dev/null diff --git a/doc/workflow/labels/label2.png b/doc/workflow/labels/label2.png Binary files differdeleted file mode 100644 index 44d9fef86d4..00000000000 --- a/doc/workflow/labels/label2.png +++ /dev/null diff --git a/doc/workflow/labels/label3.png b/doc/workflow/labels/label3.png Binary files differdeleted file mode 100644 index e2fce11b7a4..00000000000 --- a/doc/workflow/labels/label3.png +++ /dev/null |