Commit f2d6c72b authored by Craig Norris's avatar Craig Norris Committed by Marcin Sedlak-Jakubowski

Revert GraphQL API reference

As this would need changing Ruby files.
parent 039560b7
...@@ -27,7 +27,7 @@ After your merge request has been approved according to our [approval guidelines ...@@ -27,7 +27,7 @@ After your merge request has been approved according to our [approval guidelines
* At this point, it might be easy to squash the commits from the MR into one * At this point, it might be easy to squash the commits from the MR into one
* You can use the script `bin/secpick` instead of the following steps, to help you cherry-picking. See the [secpick documentation] * You can use the script `bin/secpick` instead of the following steps, to help you cherry-picking. See the [secpick documentation]
- [ ] Create each MR targeting the stable branch `X-Y-stable`, using the [Security Release merge request template]. - [ ] Create each MR targeting the stable branch `X-Y-stable`, using the [Security Release merge request template].
* Every merge request will have its own set of TODOs, so make sure to complete those. * Every merge request will have its own set of to-dos, so make sure to complete those.
- [ ] On the "Related merge requests" section, ensure that `4` merge requests are associated: The one targeting `master` and the `3` backports. - [ ] On the "Related merge requests" section, ensure that `4` merge requests are associated: The one targeting `master` and the `3` backports.
- [ ] If this issue requires less than `4` merge requests, post a message on the Security Release Tracking Issue and ping the Release Managers. - [ ] If this issue requires less than `4` merge requests, post a message on the Security Release Tracking Issue and ping the Release Managers.
......
...@@ -126,7 +126,7 @@ The following documentation relates to the DevOps **Plan** stage: ...@@ -126,7 +126,7 @@ The following documentation relates to the DevOps **Plan** stage:
| [Roadmap](user/group/roadmap/index.md) **(ULTIMATE)** | Visualize epic timelines. | | [Roadmap](user/group/roadmap/index.md) **(ULTIMATE)** | Visualize epic timelines. |
| [Service Desk](user/project/service_desk.md) | A simple way to allow people to create issues in your GitLab instance without needing their own user account. | | [Service Desk](user/project/service_desk.md) | A simple way to allow people to create issues in your GitLab instance without needing their own user account. |
| [Time Tracking](user/project/time_tracking.md) | Track time spent on issues and merge requests. | | [Time Tracking](user/project/time_tracking.md) | Track time spent on issues and merge requests. |
| [Todos](user/todos.md) | Keep track of work requiring attention with a chronological list displayed on a simple dashboard. | | [To-Do List](user/todos.md) | Keep track of work requiring attention with a chronological list displayed on a simple dashboard. |
<div align="right"> <div align="right">
<a type="button" class="btn btn-default" href="#overview"> <a type="button" class="btn btn-default" href="#overview">
...@@ -159,7 +159,7 @@ The following documentation relates to the DevOps **Create** stage: ...@@ -159,7 +159,7 @@ The following documentation relates to the DevOps **Create** stage:
| [Issue Analytics](user/group/issues_analytics/index.md) **(PREMIUM)** | Check how many issues were created per month. | | [Issue Analytics](user/group/issues_analytics/index.md) **(PREMIUM)** | Check how many issues were created per month. |
| [Merge Request Analytics](user/analytics/merge_request_analytics.md) **(PREMIUM)** | Check your throughput productivity - how many merge requests were merged per month. | | [Merge Request Analytics](user/analytics/merge_request_analytics.md) **(PREMIUM)** | Check your throughput productivity - how many merge requests were merged per month. |
| [Projects](user/project/index.md), including [project access](public_access/public_access.md)<br/>and [settings](user/project/settings/index.md) | Host source code, and control your project's visibility and set configuration. | | [Projects](user/project/index.md), including [project access](public_access/public_access.md)<br/>and [settings](user/project/settings/index.md) | Host source code, and control your project's visibility and set configuration. |
| [Search through GitLab](user/search/index.md) | Search for issues, merge requests, projects, groups, and todos. | | [Search through GitLab](user/search/index.md) | Search for issues, merge requests, projects, groups, and to-dos. |
| [Snippets](user/snippets.md) | Snippets allow you to create little bits of code. | | [Snippets](user/snippets.md) | Snippets allow you to create little bits of code. |
| [Web IDE](user/project/web_ide/index.md) | Edit files within GitLab's user interface. | | [Web IDE](user/project/web_ide/index.md) | Edit files within GitLab's user interface. |
| [Static Site Editor](user/project/static_site_editor/index.md) | Edit content on static websites. | | [Static Site Editor](user/project/static_site_editor/index.md) | Edit content on static websites. |
......
...@@ -151,7 +151,7 @@ The following API resources are available outside of project and group contexts ...@@ -151,7 +151,7 @@ The following API resources are available outside of project and group contexts
| [Sidekiq metrics](sidekiq_metrics.md) | `/sidekiq` | | [Sidekiq metrics](sidekiq_metrics.md) | `/sidekiq` |
| [Suggestions](suggestions.md) | `/suggestions` | | [Suggestions](suggestions.md) | `/suggestions` |
| [System hooks](system_hooks.md) | `/hooks` | | [System hooks](system_hooks.md) | `/hooks` |
| [Todos](todos.md) | `/todos` | | [To-dos](todos.md) | `/todos` |
| [Users](users.md) | `/users` | | [Users](users.md) | `/users` |
| [Validate `.gitlab-ci.yml` file](lint.md) | `/lint` | | [Validate `.gitlab-ci.yml` file](lint.md) | `/lint` |
| [Version](version.md) | `/version` | | [Version](version.md) | `/version` |
......
...@@ -422,10 +422,10 @@ DELETE /groups/:id/epics/:epic_iid ...@@ -422,10 +422,10 @@ DELETE /groups/:id/epics/:epic_iid
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/5" curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/5"
``` ```
## Create a todo ## Create a to-do
Manually creates a todo for the current user on an epic. If Manually creates a to-do for the current user on an epic. If
there already exists a todo for the user on that epic, status code `304` is there already exists a to-do for the user on that epic, status code `304` is
returned. returned.
```plaintext ```plaintext
......
...@@ -1496,10 +1496,10 @@ Example response: ...@@ -1496,10 +1496,10 @@ Example response:
} }
``` ```
## Create a todo ## Create a to-do
Manually creates a todo for the current user on an issue. If Manually creates a to-do for the current user on an issue. If
there already exists a todo for the user on that issue, status code `304` is there already exists a to-do for the user on that issue, status code `304` is
returned. returned.
```plaintext ```plaintext
......
...@@ -2085,10 +2085,10 @@ the `approvals_before_merge` parameter: ...@@ -2085,10 +2085,10 @@ the `approvals_before_merge` parameter:
} }
``` ```
## Create a todo ## Create a to-do
Manually creates a todo for the current user on a merge request. Manually creates a to-do for the current user on a merge request.
If there already exists a todo for the user on that merge request, If there already exists a to-do for the user on that merge request,
status code `304` is returned. status code `304` is returned.
```plaintext ```plaintext
......
...@@ -4,13 +4,13 @@ group: Project Management ...@@ -4,13 +4,13 @@ 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/#designated-technical-writers 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/#designated-technical-writers
--- ---
# Todos API # To-dos API
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/3188) in GitLab 8.10. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/3188) in GitLab 8.10.
## Get a list of todos ## Get a list of to-dos
Returns a list of todos. When no filter is applied, it returns all pending todos Returns a list of to-dos. When no filter is applied, it returns all pending to-dos
for the current user. Different filters allow the user to precise the request. for the current user. Different filters allow the user to precise the request.
```plaintext ```plaintext
...@@ -25,8 +25,8 @@ Parameters: ...@@ -25,8 +25,8 @@ Parameters:
| `author_id` | integer | no | The ID of an author | | `author_id` | integer | no | The ID of an author |
| `project_id` | integer | no | The ID of a project | | `project_id` | integer | no | The ID of a project |
| `group_id` | integer | no | The ID of a group | | `group_id` | integer | no | The ID of a group |
| `state` | string | no | The state of the todo. Can be either `pending` or `done` | | `state` | string | no | The state of the to-do. Can be either `pending` or `done` |
| `type` | string | no | The type of a todo. Can be either `Issue`, `MergeRequest`, `DesignManagement::Design` or `AlertManagement::Alert` | | `type` | string | no | The type of a to-do. Can be either `Issue`, `MergeRequest`, `DesignManagement::Design` or `AlertManagement::Alert` |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/todos" curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/todos"
...@@ -187,10 +187,10 @@ Example Response: ...@@ -187,10 +187,10 @@ Example Response:
] ]
``` ```
## Mark a todo as done ## Mark a to-do as done
Marks a single pending todo given by its ID for the current user as done. The Marks a single pending to-do given by its ID for the current user as done. The
todo marked as done is returned in the response. to-do marked as done is returned in the response.
```plaintext ```plaintext
POST /todos/:id/mark_as_done POST /todos/:id/mark_as_done
...@@ -200,7 +200,7 @@ Parameters: ...@@ -200,7 +200,7 @@ Parameters:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID of a todo | | `id` | integer | yes | The ID of a to-do |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/todos/130/mark_as_done" curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/todos/130/mark_as_done"
...@@ -285,9 +285,9 @@ Example Response: ...@@ -285,9 +285,9 @@ Example Response:
} }
``` ```
## Mark all todos as done ## Mark all to-dos as done
Marks all pending todos for the current user as done. It returns the HTTP status code `204` with an empty response. Marks all pending to-dos for the current user as done. It returns the HTTP status code `204` with an empty response.
```plaintext ```plaintext
POST /todos/mark_as_done POST /todos/mark_as_done
......
...@@ -74,8 +74,8 @@ Below are the changes made between V3 and V4. ...@@ -74,8 +74,8 @@ Below are the changes made between V3 and V4.
- `POST /projects/:id/trigger/builds` to `POST /projects/:id/trigger/pipeline` - `POST /projects/:id/trigger/builds` to `POST /projects/:id/trigger/pipeline`
- Require description when creating a new trigger `POST /projects/:id/triggers` - Require description when creating a new trigger `POST /projects/:id/triggers`
- Simplify project payload exposed on Environment endpoints [!9675](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9675) - Simplify project payload exposed on Environment endpoints [!9675](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9675)
- API uses merge request `IID`s (internal ID, as in the web UI) rather than `ID`s. This affects the merge requests, award emoji, todos, and time tracking APIs. [!9530](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9530) - API uses merge request `IID`s (internal ID, as in the web UI) rather than `ID`s. This affects the merge requests, award emoji, to-dos, and time tracking APIs. [!9530](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9530)
- API uses issue `IID`s (internal ID, as in the web UI) rather than `ID`s. This affects the issues, award emoji, todos, and time tracking APIs. [!9530](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9530) - API uses issue `IID`s (internal ID, as in the web UI) rather than `ID`s. This affects the issues, award emoji, to-dos, and time tracking APIs. [!9530](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9530)
- Change initial page from `0` to `1` on `GET /projects/:id/repository/commits` (like on the rest of the API) [!9679](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9679) - Change initial page from `0` to `1` on `GET /projects/:id/repository/commits` (like on the rest of the API) [!9679](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9679)
- Return correct `Link` header data for `GET /projects/:id/repository/commits` [!9679](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9679) - Return correct `Link` header data for `GET /projects/:id/repository/commits` [!9679](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9679)
- Update endpoints for repository files [!9637](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9637) - Update endpoints for repository files [!9637](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9637)
......
...@@ -175,7 +175,7 @@ guide on how you can add a new custom validator. ...@@ -175,7 +175,7 @@ guide on how you can add a new custom validator.
validates the parameter value for different cases. Mainly, it checks whether a validates the parameter value for different cases. Mainly, it checks whether a
path is relative and does it contain `../../` relative traversal using path is relative and does it contain `../../` relative traversal using
`File::Separator` or not, and whether the path is absolute, for example `File::Separator` or not, and whether the path is absolute, for example
`/etc/passwd/`. By default, absolute paths are not allowed. However, you can optionally pass in an allowlist for allowed absolute paths in the following way: `/etc/passwd/`. By default, absolute paths are not allowed. However, you can optionally pass in an allowlist for allowed absolute paths in the following way:
`requires :file_path, type: String, file_path: { allowlist: ['/foo/bar/', '/home/foo/', '/app/home'] }` `requires :file_path, type: String, file_path: { allowlist: ['/foo/bar/', '/home/foo/', '/app/home'] }`
- `Git SHA`: - `Git SHA`:
...@@ -249,7 +249,7 @@ most basic entity, with successive entities building upon that scope. ...@@ -249,7 +249,7 @@ most basic entity, with successive entities building upon that scope.
The `with_api_entity_associations` scope will also [automatically preload The `with_api_entity_associations` scope will also [automatically preload
data](https://gitlab.com/gitlab-org/gitlab/blob/19f74903240e209736c7668132e6a5a735954e7c/app%2Fmodels%2Ftodo.rb#L34) data](https://gitlab.com/gitlab-org/gitlab/blob/19f74903240e209736c7668132e6a5a735954e7c/app%2Fmodels%2Ftodo.rb#L34)
for `Todo` _targets_ when returned in the Todos API. for `Todo` _targets_ when returned in the [to-dos API](../api/todos.md).
For more context and discussion about preloading see For more context and discussion about preloading see
[this merge request](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/25711) [this merge request](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/25711)
......
...@@ -369,6 +369,7 @@ create an issue or an MR to propose a change to the user interface text. ...@@ -369,6 +369,7 @@ create an issue or an MR to propose a change to the user interface text.
- milestones - milestones
- reorder issues - reorder issues
- runner, runners, shared runners - runner, runners, shared runners
- a to-do, to-dos
- *Some features are capitalized*, typically nouns naming GitLab-specific - *Some features are capitalized*, typically nouns naming GitLab-specific
capabilities or tools. For example: capabilities or tools. For example:
- GitLab CI/CD - GitLab CI/CD
......
...@@ -30,12 +30,12 @@ The **Overview** tab provides basic information about the alert: ...@@ -30,12 +30,12 @@ The **Overview** tab provides basic information about the alert:
![Alert Full Details](./img/alert_detail_full_v13_1.png) ![Alert Full Details](./img/alert_detail_full_v13_1.png)
### Update an Alert's status ### Update an alert's status
The Alert detail view enables you to update the Alert Status. The Alert detail view enables you to update the Alert Status.
See [Create and manage alerts in GitLab](./alerts.md) for more details. See [Create and manage alerts in GitLab](./alerts.md) for more details.
### Create an Issue from an Alert ### Create an issue from an alert
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217745) in GitLab 13.1. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217745) in GitLab 13.1.
...@@ -47,7 +47,7 @@ alert by clicking the **View Issue** button. ...@@ -47,7 +47,7 @@ alert by clicking the **View Issue** button.
Closing a GitLab issue associated with an alert changes the alert's status to Resolved. Closing a GitLab issue associated with an alert changes the alert's status to Resolved.
See [Create and manage alerts in GitLab](alerts.md) for more details about alert statuses. See [Create and manage alerts in GitLab](alerts.md) for more details about alert statuses.
### Update an Alert's assignee ### Update an alert's assignee
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab 13.1. > [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab 13.1.
...@@ -73,7 +73,7 @@ GitLab currently only supports a single assignee per alert. ...@@ -73,7 +73,7 @@ GitLab currently only supports a single assignee per alert.
**{angle-double-right}** **Expand sidebar** to expand it. **{angle-double-right}** **Expand sidebar** to expand it.
1. In the right sidebar, locate the **Assignee** and click **Edit**. From the 1. In the right sidebar, locate the **Assignee** and click **Edit**. From the
dropdown menu, select each user you want to assign to the alert. GitLab creates dropdown menu, select each user you want to assign to the alert. GitLab creates
a [To-Do list item](../../user/todos.md) for each user. a [to-do list item](../../user/todos.md) for each user.
![Alert Details View Assignee(s)](./img/alert_todo_assignees_v13_1.png) ![Alert Details View Assignee(s)](./img/alert_todo_assignees_v13_1.png)
...@@ -96,12 +96,12 @@ The following actions will result in a system note: ...@@ -96,12 +96,12 @@ The following actions will result in a system note:
![Alert Details View System Notes](./img/alert_detail_system_notes_v13_1.png) ![Alert Details View System Notes](./img/alert_detail_system_notes_v13_1.png)
### Create a To-Do from an Alert ### Create a to-do from an alert
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab 13.1. > [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab 13.1.
You can manually create [To-Do list items](../../user/todos.md) for yourself from the You can manually create [To-Do list items](../../user/todos.md) for yourself from the
Alert details screen, and view them later on your **To-Do List**. To add a To-Do: Alert details screen, and view them later on your **To-Do List**. To add a to-do:
1. To display the list of current alerts, click 1. To display the list of current alerts, click
**{cloud-gear}** **Operations > Alerts**. **{cloud-gear}** **Operations > Alerts**.
...@@ -110,11 +110,11 @@ Alert details screen, and view them later on your **To-Do List**. To add a To-Do ...@@ -110,11 +110,11 @@ Alert details screen, and view them later on your **To-Do List**. To add a To-Do
![Alert Details Add A To Do](./img/alert_detail_add_todo_v13_1.png) ![Alert Details Add A To Do](./img/alert_detail_add_todo_v13_1.png)
Click the **To-Do** **{todo-done}** in the navigation bar to view your current To-Do list. Click the **To-Do** **{todo-done}** in the navigation bar to view your current to-do list.
![Alert Details Added to Do](./img/alert_detail_added_todo_v13_1.png) ![Alert Details Added to Do](./img/alert_detail_added_todo_v13_1.png)
### View an Alert's metrics data ### View an alert's metrics data
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217768) in GitLab 13.2. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217768) in GitLab 13.2.
...@@ -154,7 +154,7 @@ unassign their account from the alert when their role is complete. ...@@ -154,7 +154,7 @@ unassign their account from the alert when their role is complete.
The alert status can be updated on the [Alert list](./alerts.md) to The alert status can be updated on the [Alert list](./alerts.md) to
reflect if the alert has been resolved. reflect if the alert has been resolved.
## View an Alert's logs ## View an alert's logs
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217768) in GitLab 13.3. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217768) in GitLab 13.3.
......
...@@ -47,7 +47,7 @@ The GitLab University curriculum is composed of GitLab videos, screencasts, pres ...@@ -47,7 +47,7 @@ The GitLab University curriculum is composed of GitLab videos, screencasts, pres
1. [Repositories, Projects and Groups - Video](https://www.youtube.com/watch?v=4TWfh1aKHHw&index=1&list=PLFGfElNsQthbQu_IWlNOxul0TbS_2JH-e) 1. [Repositories, Projects and Groups - Video](https://www.youtube.com/watch?v=4TWfh1aKHHw&index=1&list=PLFGfElNsQthbQu_IWlNOxul0TbS_2JH-e)
1. [Creating a Project in GitLab - Video](https://www.youtube.com/watch?v=7p0hrpNaJ14) 1. [Creating a Project in GitLab - Video](https://www.youtube.com/watch?v=7p0hrpNaJ14)
1. [How to Create Files and Directories](https://about.gitlab.com/blog/2016/02/10/feature-highlight-create-files-and-directories-from-files-page/) 1. [How to Create Files and Directories](https://about.gitlab.com/blog/2016/02/10/feature-highlight-create-files-and-directories-from-files-page/)
1. [GitLab Todos](https://about.gitlab.com/blog/2016/03/02/gitlab-todos-feature-highlight/) 1. [GitLab To-Do List](https://about.gitlab.com/blog/2016/03/02/gitlab-todos-feature-highlight/)
1. [GitLab's Work in Progress (WIP) Flag](https://about.gitlab.com/blog/2016/01/08/feature-highlight-wip/) 1. [GitLab's Work in Progress (WIP) Flag](https://about.gitlab.com/blog/2016/01/08/feature-highlight-wip/)
### 1.5. Migrating from other Source Control ### 1.5. Migrating from other Source Control
......
...@@ -22,11 +22,11 @@ known response, the result is cached for 6 hours. ...@@ -22,11 +22,11 @@ known response, the result is cached for 6 hours.
If the external authorization is enabled, GitLab will further block pages and If the external authorization is enabled, GitLab will further block pages and
functionality that render cross-project data. That includes: functionality that render cross-project data. That includes:
- most pages under Dashboard (Activity, Milestones, Snippets, Assigned merge - Most pages under Dashboard (Activity, Milestones, Snippets, Assigned merge
requests, Assigned issues, Todos) requests, Assigned issues, To-Do List).
- under a specific group (Activity, Contribution analytics, Issues, Issue boards, - Under a specific group (Activity, Contribution analytics, Issues, Issue boards,
Labels, Milestones, Merge requests) Labels, Milestones, Merge requests).
- Global and Group search will be disabled - Global and Group search will be disabled.
This is to prevent performing to many requests at once to the external This is to prevent performing to many requests at once to the external
authorization service. authorization service.
......
...@@ -361,7 +361,7 @@ Here are possible causes and solutions: ...@@ -361,7 +361,7 @@ Here are possible causes and solutions:
Getting both of these errors at the same time suggests the NameID capitalization provided by the Identity Provider didn't exactly match the previous value for that user. Getting both of these errors at the same time suggests the NameID capitalization provided by the Identity Provider didn't exactly match the previous value for that user.
This can be prevented by configuring the [NameID](#nameid) to return a consistent value. Fixing this for an individual user involves [unlinking SAML in the GitLab account](#unlinking-accounts), although this will cause group membership and Todos to be lost. This can be prevented by configuring the [NameID](#nameid) to return a consistent value. Fixing this for an individual user involves [unlinking SAML in the GitLab account](#unlinking-accounts), although this will cause group membership and to-dos to be lost.
### Message: "Request to link SAML account must be authorized" ### Message: "Request to link SAML account must be authorized"
......
...@@ -134,10 +134,10 @@ the best of GitLab Flavored Markdown in your threads, comments, ...@@ -134,10 +134,10 @@ the best of GitLab Flavored Markdown in your threads, comments,
issues and merge requests descriptions, and everywhere else GFM is issues and merge requests descriptions, and everywhere else GFM is
supported. supported.
## Todos ## To-Do List
Never forget to reply to your collaborators. [GitLab Todos](todos.md) Never forget to reply to your collaborators. [GitLab To-Do List](todos.md)
are a tool for working faster and more effectively with your team, is a tool for working faster and more effectively with your team,
by listing all user or group mentions, as well as issues and merge by listing all user or group mentions, as well as issues and merge
requests you're assigned to. requests you're assigned to.
......
...@@ -114,7 +114,7 @@ You have 8 options here that you can use for your default dashboard view: ...@@ -114,7 +114,7 @@ You have 8 options here that you can use for your default dashboard view:
- Your projects' activity - Your projects' activity
- Starred projects' activity - Starred projects' activity
- Your groups - Your groups
- Your [Todos](../todos.md) - Your [to-dos](../todos.md)
- Assigned Issues - Assigned Issues
- Assigned Merge Requests - Assigned Merge Requests
- Operations Dashboard **(PREMIUM)** - Operations Dashboard **(PREMIUM)**
......
...@@ -44,9 +44,9 @@ the icon and the date colored red. You can sort issues by those that are ...@@ -44,9 +44,9 @@ the icon and the date colored red. You can sort issues by those that are
![Issues with due dates in the issues index page](img/due_dates_issues_index_page.png) ![Issues with due dates in the issues index page](img/due_dates_issues_index_page.png)
Due dates also appear in your [todos list](../../todos.md). Due dates also appear in your [to-do list](../../todos.md).
![Issues with due dates in the todos](img/due_dates_todos.png) ![Issues with due dates in the to-dos](img/due_dates_todos.png)
The day before an open issue is due, an email will be sent to all participants The day before an open issue is due, an email will be sent to all participants
of the issue. Like the due date, the "day before the due date" is determined by the of the issue. Like the due date, the "day before the due date" is determined by the
......
...@@ -196,7 +196,7 @@ allowing many formatting options. ...@@ -196,7 +196,7 @@ allowing many formatting options.
### Mentions ### Mentions
You can mention a user or a group present in your GitLab instance with `@username` or You can mention a user or a group present in your GitLab instance with `@username` or
`@groupname` and they will be notified via todos and email, unless they have disabled `@groupname` and they will be notified via to-dos and email, unless they have disabled
all notifications in their profile settings. This is controlled in the all notifications in their profile settings. This is controlled in the
[notification settings](../../profile/notifications.md). [notification settings](../../profile/notifications.md).
......
...@@ -5,67 +5,75 @@ group: Project Management ...@@ -5,67 +5,75 @@ 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/#designated-technical-writers 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/#designated-technical-writers
--- ---
# GitLab To-Do List # GitLab To-Do List **(CORE)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/2817) in GitLab 8.5. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/2817) in GitLab 8.5.
When you log into GitLab, you normally want to see where you should spend your When you sign in to GitLab, you normally want to determine where you should
time, take some action, or know what you need to keep an eye on without spend your time. This can include taking an action, or keeping track of things
a huge pile of e-mail notifications. GitLab is where you do your work, (without having to read lots of email notifications). Because GitLab is where you
so being able to get started quickly is important. do your work, being able to get started quickly is important.
Your To-Do List offers a chronological list of items that are waiting for your input, all Your *To-Do List* offers a chronological list of items waiting for your input
in a simple dashboard. (known as *to-dos*) in a single dashboard.
![To Do screenshot showing a list of items to check on](img/todos_index.png) The To-Do List supports tracking [actions](#what-triggers-a-to-do) related to
the following:
You can quickly access your To-Do List by clicking the checkmark icon next to the - Issues
search bar in the top navigation. If the count is: - Merge Requests
- Epics **(ULTIMATE)**
- Less than 100, the number in blue is the number of To-Do items. ![to-do screenshot showing a list of items to check on](img/todos_index.png)
- 100 or more, the number displays as 99+. The exact number displays
on the To-Do List. You can access your To-Do List by clicking the **{task-done}** To-Do List icon
you still have open. Otherwise, the number displays as 99+. The exact number next to the search bar in the top navigation. If the to-do item count is:
displays on the 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.
![To Do icon](img/todos_icon.png) ![To Do icon](img/todos_icon.png)
## What triggers a To Do ## What triggers a to-do
A To Do appears on your To-Do List when: A to-do item appears on your To-Do List when:
- An issue or merge request is assigned to you - An issue or merge request is assigned to you.
- You are `@mentioned` in the description or comment of an: - You're `@mentioned` in the description or comment of an issue or merge request
- Issue (or epic **(ULTIMATE)**).
- Merge Request
- Epic **(ULTIMATE)**
- You are `@mentioned` in a comment on a: - You are `@mentioned` in a comment on a:
- Commit - Commit
- Design - Design
- The CI/CD pipeline for your merge request failed - The CI/CD pipeline for your merge request failed.
- An open merge request becomes unmergeable due to conflict, and one of the following is true: - An open merge request becomes unmergeable due to conflict, and one of the
- You are the author following is true:
- You are the user that set it to automatically merge once the pipeline succeeds - You're the author.
- [Since GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/issues/12136), a merge request - You're the user that set the merge request to automatically merge after a
is removed from a [merge train](../ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md) pipeline succeeds.
and you are the user that added it. **(PREMIUM)** - [Since GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/issues/12136), a
merge request is removed from a
When multiple trigger actions occur for the same user on the same object (for example, an issue) [merge train](../ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md),
only the first is displayed as a single to-do on their To-Do List. and you're the user that added it. **(PREMIUM)**
To-do triggers are not affected by [GitLab Notification Email settings](profile/notifications.md). 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.
To-do triggers aren't affected by [GitLab notification email settings](profile/notifications.md).
NOTE: **Note:** NOTE: **Note:**
When a user no longer has access to a resource related to a To Do (like an issue, merge request, When a user no longer has access to a resource related to a to-do (such as an
project, or group) the related To-Do items are deleted within the next hour for security reasons. issue, merge request, project, or group), for security reasons GitLab deletes
The delete is delayed to prevent data loss, in case the user's access was revoked by mistake. 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.
### Directly addressing a To Do ### Directly addressing a to-do
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/7926) in GitLab 9.0. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/7926) in GitLab 9.0.
If you are mentioned at the start of a line, the To Do you receive will be listed If you're mentioned at the start of a line, the to-do you receive will be listed
as 'directly addressed'. For example, in this comment: as *directly addressed*. For example, in the following comment:
```markdown ```markdown
@alice What do you think? cc: @bob @alice What do you think? cc: @bob
...@@ -79,81 +87,71 @@ as 'directly addressed'. For example, in this comment: ...@@ -79,81 +87,71 @@ as 'directly addressed'. For example, in this comment:
@erin @frank thank you! @erin @frank thank you!
``` ```
The people receiving directly addressed To-Do items are `@alice`, `@erin`, and 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 `@frank`. Directly addressed to-do items only differ from mentions in their type
for filtering purposes; otherwise, they appear as normal. for filtering purposes; otherwise, they appear as normal.
### Manually creating a To Do ### Manually creating a to-do
You can also add the following to your To-Do List by clicking the **Add a To Do** button on an: You can add an issue or merge request (or epic **(ULTIMATE)**) to your
To-Do List by clicking its **Add a To Do** button.
- Issue
- Merge Request
- Epic **(ULTIMATE)**
![Adding a To Do from the issuable sidebar](img/todos_add_todo_sidebar.png) ![Adding a To Do from the issuable sidebar](img/todos_add_todo_sidebar.png)
## Marking a To Do as done ## Marking a to-do as done
Any action to the following will mark the corresponding To Do as done:
- Issue Any action to an issue or merge request (or epic **(ULTIMATE)**) will mark its
- Merge Request corresponding to-do as done.
- Epic **(ULTIMATE)**
Actions that dismiss To-Do items include: Actions that dismiss to-do items include:
- Changing the assignee - Changing the assignee
- Changing the milestone - Changing the milestone
- Adding/removing a label - Adding/removing a label
- Commenting on the issue - Commenting on the issue
Your To-Do List is personal, and items are only marked as done if the action comes from Your To-Do List is personal, and items are only marked as done if you take
you. If you close the issue or merge request, your To Do is automatically action. If you close the issue or merge request, your to-do is marked as done.
marked as done.
To prevent other users from closing issues without you being notified, if someone else closes, merges, or takes action on the any of the following, your To Do will remain pending:
- Issue
- Merge request
- Epic **(ULTIMATE)**
There is just one To Do for each of these, so mentioning a user a hundred times in an issue will only trigger one To Do. To prevent other users from closing issues without you being notified, if
someone else closes, merges, or takes action on an issue or merge request (or
epic **(ULTIMATE)**), your to-do will remain pending.
If no action is needed, you can manually mark the To Do as done by clicking the There's just one to-do for each of these, so mentioning a user many times in an
corresponding **Done** button, and it will disappear from your To-Do List. issue will only trigger one to-do item.
![A To Do in the To-Do List](img/todos_todo_list_item.png) If no action is needed, you can manually mark the to-do as done by clicking its
corresponding **Done** button to have GitLab remove the item from your
To-Do List.
You can also mark a To Do as done by clicking the **Mark as done** button in the sidebar of the following: ![A to-do in the To-Do List](img/todos_todo_list_item.png)
- Issue You can also mark a to-do as done by clicking the **Mark as done** button in the
- Merge Request sidebar of an issue or merge request (or epic **(ULTIMATE)**).
- Epic **(ULTIMATE)**
![Mark as done from the issuable sidebar](img/todos_mark_done_sidebar.png) ![Mark as done from the issuable sidebar](img/todos_mark_done_sidebar.png)
You can mark all your To-Do items as done at once by clicking the **Mark all as You can mark all your to-do items as done at once by clicking the
done** button. **Mark all as done** button.
## Filtering your To-Do List ## Filtering your To-Do List
There are four kinds of filters you can use on your To-Do List. You can use the following types of filters with your To-Do List:
| Filter | Description | | Filter | Description |
| ------- | ----------- | | ------- | ---------------------------------------------------------------- |
| Project | Filter by project | | Project | Filter by project. |
| Group | Filter by group | | Group | Filter by group. |
| Author | Filter by the author that triggered the To Do | | Author | Filter by the author that triggered the To Do. |
| Type | Filter by issue, merge request, design, or epic **(ULTIMATE)** | | Type | Filter by issue, merge request, design, or epic. **(ULTIMATE)** |
| Action | Filter by the action that triggered the To Do | | Action | Filter by the action that triggered the To Do. |
You can also filter by more than one of these at the same time. The possible Actions are You can also filter by more than one of these at the same time. The previously
[described above](#what-triggers-a-to-do) and include: described [triggering actions](#what-triggers-a-to-do) include:
- Any Action - Any action
- Assigned - Assigned
- Mentioned - Mentioned
- Added - Added
- Pipelines - Pipelines
- Directly Addressed - Directly addressed
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment