diff options
Diffstat (limited to 'doc/user/todos.md')
| -rw-r--r-- | doc/user/todos.md | 144 |
1 files changed, 59 insertions, 85 deletions
diff --git a/doc/user/todos.md b/doc/user/todos.md index 719ab6f6e7c..f0601db0300 100644 --- a/doc/user/todos.md +++ b/doc/user/todos.md @@ -5,47 +5,37 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# GitLab To-Do List **(FREE)** +# To-Do List **(FREE)** > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/2817) in GitLab 8.5. -When you sign in to GitLab, you normally want to determine where you should -spend your time. This can include taking an action, or keeping track of things -(without having to read lots of email notifications). Because GitLab is where you -do your work, being able to get started quickly is important. +Your *To-Do List* is a chronological list of items waiting for your input. +The items are known as *to-do items*. -Your *To-Do List* offers a chronological list of items waiting for your input -(known as *to-do items*) in a single dashboard. - -The To-Do List supports tracking [actions](#what-triggers-a-to-do-item) related to -the following: +You can use the To-Do List to track [actions](#actions-that-create-to-do-items) related to: - [Issues](project/issues/index.md) - [Merge requests](project/merge_requests/index.md) - [Epics](group/epics/index.md) - [Designs](project/issues/design_management.md) - +## Access the To-Do List -You can access your To-Do List by clicking the To-Do List icon (**{task-done}**) -next to the search bar in the top navigation. If the to-do item count is: +To access your To-Do List: -- *Less than 100*, the number in blue is the number of to-do items. -- *100 or more*, the number displays as 99+. The exact number displays in the - To-Do List. +On the top bar, in the top right, select To-Do List (**{task-done}**). -## What triggers a to-do item +## Actions that create to-do items -A to-do item appears on your To-Do List when: +Many to-do items are created automatically. +A to-do item is added to your To-Do List when: - An issue or merge request is assigned to you. -- You're `@mentioned` in the description or comment of an issue or merge request - (or epic). -- You are `@mentioned` in a comment on a: - - Commit - - Design -- The CI/CD pipeline for your merge request failed. -- An open merge request becomes unmergeable due to conflict, and one of the +- You're [mentioned](project/issues/issue_data_and_actions.md#mentions) in the description or + comment of an issue, merge request, or epic. +- You are mentioned in a comment on a commit or design. +- The CI/CD pipeline for your merge request fails. +- An open merge request cannot be merged due to conflict, and one of the following is true: - You're the author. - You're the user that set the merge request to automatically merge after a @@ -55,24 +45,32 @@ A to-do item appears on your To-Do List when: [merge train](../ci/pipelines/merge_trains.md), and you're the user that added it. -When several trigger actions occur for the same user on the same object (for -example, an issue), GitLab displays only the first action as a single to-do -item. +When several actions occur for the same user on the same object, +GitLab displays the first action as a single to-do item. + +To-do items aren't affected by [GitLab notification email settings](profile/notifications.md). + +## Create a to-do item + +You can manually add an item to your To-Do List. -To-do item triggers aren't affected by [GitLab notification email settings](profile/notifications.md). +1. Go to your: -NOTE: -When a user no longer has access to a resource related to a to-do item (such as -an issue, merge request, epic, project, or group), for security reasons GitLab -deletes any related to-do items within the next hour. Deletion is delayed to -prevent data loss, in the case where a user's access is accidentally revoked. + - [Issue](project/issues/index.md) + - [Merge request](project/merge_requests/index.md) + - [Epic](group/epics/index.md) + - [Design](project/issues/design_management.md) -### Directly addressing a to-do item +1. On the right sidebar, at the top, select **Add a to do**. + +  + +## Create a to-do item by directly addressing someone > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/7926) in GitLab 9.0. -If you're mentioned at the start of a line, the to-do item you receive is -listed as *directly addressed*. For example, in the following comment: +You can create a to-do item by directly addressing someone at the start of a line. +For example, in the following comment: ```markdown @alice What do you think? cc: @bob @@ -86,22 +84,15 @@ listed as *directly addressed*. For example, in the following comment: @erin @frank thank you! ``` -The people receiving directly addressed to-do items are `@alice`, `@erin`, and -`@frank`. Directly addressed to-do items only differ from mentions in their type -for filtering purposes; otherwise, they appear as normal. +The people who receive to-do items are `@alice`, `@erin`, and +`@frank`. -### Manually creating a to-do item +To view to-do items where a user was directly addressed, go to the To-Do List and +from the **Action** filter, select **Directly addressed**. -You can also add the following to your To-Do List by clicking the **Add a to do** button on: +Mentioning a user many times only creates one to-do item. -- [Issues](project/issues/index.md) -- [Merge requests](project/merge_requests/index.md) -- [Epics](group/epics/index.md) -- [Designs](project/issues/design_management.md) - - - -## Marking a to-do item as done +## Actions that mark a to-do item as done Any action to an issue, merge request, or epic marks its corresponding to-do item as done. @@ -110,53 +101,36 @@ Actions that dismiss to-do items include: - Changing the assignee - Changing the milestone -- Adding/removing a label +- Closing the issue or merge request +- Adding or removing a label - Commenting on the issue - Resolving a [design discussion thread](project/issues/design_management.md#resolve-design-threads) -Your To-Do List is personal, and items are only marked as done if you take -action. If you close the issue or merge request, your to-do item is marked as -done. - -To prevent other users from closing issues without you being notified, if -someone else closes, merges, or takes action on an issue, merge request, or +If someone else closes, merges, or takes action on an issue, merge request, or epic, your to-do item remains pending. -There's just one to-do item for each of these, so mentioning a user many times -in an issue only triggers one to-do item. +## Mark a to-do item as done -If no action is needed, you can manually mark the to-do item as done by -clicking its corresponding **Done** button to have GitLab remove the item from -your To-Do List. +You can manually mark a to-do item as done. - +There are two ways to do this: -You can also mark a to-do item as done by clicking the **Mark as done** button -in the sidebar of an issue, merge request, or epic. +- In the To-Do List, to the right of the to-do item, select **Done**. +- In the sidebar of an issue, merge request, or epic, select **Mark as done**. - +  -You can mark all your to-do items as done at once by clicking the -**Mark all as done** button. +## Mark all to-do items as done -## Filtering your To-Do List +You can mark all your to-do items as done at the same time. -You can use the following types of filters with your To-Do List: +In the To-Do List, in the top right, select **Mark all as done**. -| Filter | Description | -| ------- | ---------------------------------------------------------------- | -| Project | Filter by project. | -| Group | Filter by group. | -| Author | Filter by the author that triggered the to-do item. | -| Type | Filter by issue, merge request, design, or epic. | -| Action | Filter by the action that triggered the to-do item. | +## How a user's To-Do List is affected when their access changes -You can also filter by more than one of these at the same time. The previously -described [triggering actions](#what-triggers-a-to-do-item) include: +For security reasons, GitLab deletes to-do items when a user no longer has access to a related resource. +For example, if the user no longer has access to an issue, merge request, epic, project, or group, +GitLab deletes the related to-do items. -- Any action -- Assigned -- Mentioned -- Added -- Pipelines -- Directly addressed +This process occurs in the hour after their access changes. Deletion is delayed to +prevent data loss, in case the user's access was accidentally revoked. |