diff options
Diffstat (limited to 'doc/user/tasks.md')
| -rw-r--r-- | doc/user/tasks.md | 80 |
1 files changed, 58 insertions, 22 deletions
diff --git a/doc/user/tasks.md b/doc/user/tasks.md index 173d2e44cf1..1ec211dcab3 100644 --- a/doc/user/tasks.md +++ b/doc/user/tasks.md @@ -1,7 +1,7 @@ --- stage: Plan group: Project Management -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Tasks **(FREE ALL)** @@ -53,6 +53,8 @@ Prerequisites: To create a task: +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Plan > Issues**, then select your issue to view it. 1. In the issue description, in the **Tasks** section, select **Add**. 1. Select **New task**. 1. Enter the task title. @@ -66,9 +68,9 @@ Prerequisites: - You must have at least the Reporter role for the project. -In an issue description with task list items: - -1. Hover over a task list item and select the options menu (**{ellipsis_v}**). +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Plan > Issues**, then select your issue to view it. +1. In the issue description, hover over a task list item and select the options menu (**{ellipsis_v}**). 1. Select **Convert to task**. The task list item is removed from the issue description and a task is created in the tasks widget from its contents. @@ -84,6 +86,8 @@ Prerequisites: To add a task: +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Plan > Issues**, then select your issue to view it. 1. In the issue description, in the **Tasks** section, select **Add**. 1. Select **Existing task**. 1. Search tasks by title. @@ -98,6 +102,8 @@ Prerequisites: To edit a task: +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Plan > Issues**, then select your issue to view it. 1. In the issue description, in the **Tasks** section, select the task you want to edit. The task window opens. 1. Optional. To edit the title, select it and make your changes. @@ -124,7 +130,9 @@ Prerequisites: To edit the description of a task: -1. In the **Tasks** section, select the title of the task you want to edit. +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Plan > Issues**, then select your issue to view it. +1. In the issue description, in the **Tasks** section, select the title of the task you want to edit. The task window opens. 1. Next to **Description**, select the edit icon (**{pencil}**). The description text box appears. 1. Above the text box, select **Rich text**. @@ -151,7 +159,10 @@ It's not possible to connect them again. To remove a task from an issue: -1. In the issue description, in the **Tasks** section, next to the task you want to remove, select the options menu (**{ellipsis_v}**). +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Plan > Issues**, then select your issue to view it. +1. In the issue description, in the **Tasks** section, select the options menu (**{ellipsis_v}**) + next to the task you want to remove. 1. Select **Remove task**. ## Delete a task @@ -164,6 +175,8 @@ Prerequisites: To delete a task: +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Plan > Issues**, then select your issue to view it. 1. In the issue description, in the **Tasks** section, select the task you want to edit. 1. In the task window, in the options menu (**{ellipsis_v}**), select **Delete task**. 1. Select **OK**. @@ -195,6 +208,8 @@ Prerequisites: To change the assignee on a task: +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Plan > Issues**, then select your issue to view it. 1. In the issue description, in the **Tasks** section, select the title of the task you want to edit. The task window opens. 1. Next to **Assignees**, select **Add assignees**. @@ -211,6 +226,8 @@ Prerequisites: To add [labels](project/labels.md) to a task: +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Plan > Issues**, then select your issue to view it. 1. In the issue description, in the **Tasks** section, select the title of the task you want to edit. The task window opens. 1. Next to **Labels**, select **Add labels**. 1. From the dropdown list, select the labels to add. @@ -231,6 +248,8 @@ You can set start and due dates on a task to show when work should begin and end To set a due date: +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Plan > Issues**, then select your issue to view it. 1. In the issue description, in the **Tasks** section, select the title of the task you want to edit. The task window opens. 1. If the task already has a due date next to **Due date**, select it. Otherwise, select **Add due date**. @@ -263,6 +282,8 @@ Prerequisites: To add a task to a milestone: +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Plan > Issues**, then select your issue to view it. 1. In the issue description, in the **Tasks** section, select the title of the task you want to edit. The task window opens. 1. Next to **Milestone**, select **Add to milestone**. @@ -271,7 +292,8 @@ To add a task to a milestone: ## Set task weight **(PREMIUM ALL)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/362550) in GitLab 15.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/362550) in GitLab 15.3. +> - Edit button [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/429137) in GitLab 16.7. Prerequisites: @@ -282,10 +304,13 @@ This value is visible only when you view a task. To set issue weight of a task: +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Plan > Issues**, then select your issue to view it. 1. In the issue description, in the **Tasks** section, select the title of the task you want to edit. The task window opens. -1. Next to **Weight**, enter a whole, positive number. -1. Select the close icon (**{close}**). +1. Next to **Weight**, select **Edit**. +1. Enter a whole, positive number. +1. Select **Apply** or press <kbd>Enter</kbd>. ## Add a task to an iteration **(PREMIUM ALL)** @@ -306,6 +331,8 @@ Prerequisites: To add a task to an iteration: +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Plan > Issues**, then select your issue to view it. 1. In the issue description, in the **Tasks** section, select the title of the task you want to edit. The task window opens. 1. Next to **Iteration**, select **Add to iteration**. @@ -337,7 +364,8 @@ To refer to a task elsewhere in GitLab, you can use its full URL or a short refe To copy the task reference to your clipboard: 1. On the left sidebar, select **Search or go to** and find your project. -1. Select **Plan > Issues**, then select your task to view it. +1. Select **Plan > Issues**, then select your issue to view it. +1. In the issue description, in the **Tasks** section, select your task. 1. In the top right corner, select the vertical ellipsis (**{ellipsis_v}**), then select **Copy Reference**. You can now paste the reference into another description or comment. @@ -364,13 +392,15 @@ To copy the task's email address: > [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11198) in GitLab 16.5. -Prerequisite: +Prerequisites: - You must have at least the Reporter role for the project. - The issue and task must belong to the same project. To set an issue as a parent of a task: +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Plan > Issues**, then select your issue to view it. 1. In the issue description, in the **Tasks** section, select the title of the task you want to edit. The task window opens. 1. Next to **Parent**, from the dropdown list, select the parent to add. @@ -461,16 +491,16 @@ When enabled, tasks use a two-column layout, similar to issues. The description and threads are on the left, and attributes, such as labels or assignees, on the right. - + -## Linked items in Tasks +## Linked items in tasks -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/416558) in GitLab 16.5 [with a flag](../administration/feature_flags.md) named `linked_work_items`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/416558) in GitLab 16.5 [with a flag](../administration/feature_flags.md) named `linked_work_items`. Disabled by default. +> - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/139394) in GitLab 16.7. FLAG: -On self-managed GitLab, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../administration/feature_flags.md) named `linked_work_items`. -On GitLab.com, this feature is not available. -This feature is not ready for production use. +On self-managed GitLab, by default this feature is available. To hide the feature, an administrator can [disable the feature flag](../administration/feature_flags.md) named `linked_work_items`. +On GitLab.com, this feature is available. Linked items are a bi-directional relationship and appear in a block below the emoji reactions section. You can link an objective, key result, or a task in the same project with each other. @@ -479,14 +509,17 @@ The relationship only shows up in the UI if the user can see both items. ### Add a linked item -Prerequisite: +Prerequisites: - You must have at least the Guest role for the project. To link an item to a task: +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Plan > Issues**, then select your issue to view it. +1. In the issue description, in the **Tasks** section, select your task. 1. In the **Linked items** section of a task, - select the **Add** button. + select **Add**. 1. Select the relationship between the two items. Either: - **relates to** - **blocks** @@ -501,11 +534,14 @@ them categorized so their relationships can be better understood visually. ### Remove a linked item -Prerequisite: +Prerequisites: - You must have at least the Guest role for the project. -In the **Linked items** section of a task, -next to each item, select the vertical ellipsis (**{ellipsis_v}**) and then select **Remove**. +1. On the left sidebar, select **Search or go to** and find your project. +1. Select **Plan > Issues**, then select your issue to view it. +1. In the issue description, in the **Tasks** section, select your task. +1. In the **Linked items** section of a task, next to each item, select the vertical + ellipsis (**{ellipsis_v}**) and then select **Remove**. Due to the bi-directional relationship, the relationship no longer appears in either item. |