Skip to content

G
gitlab-ce
Commit 69ab9e1c authored by Craig Norris's avatar Craig Norris
Browse files
Options

Merge branch 'msj-todo-fix' into 'master' 

Format "to do" as noun with a space

See merge request gitlab-org/gitlab!44167
parents f476a50c 89cde97e
Hide whitespace changes
Inline Side-by-side
Showing with 35 additions and 35 deletions
doc/api/epics.md
View file @ 69ab9e1c
......@@ -424,10 +424,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"
```
## Create a to-do
## Create a to do
Manually creates a to-do for the current user on an epic. If
there already exists a to-do for the user on that epic, status code `304` is
Manually creates a to do for the current user on an epic. If
there already exists a to do for the user on that epic, status code `304` is
returned.
```plaintext
......
doc/api/issues.md
View file @ 69ab9e1c
......@@ -1507,10 +1507,10 @@ Example response:
}
```
## Create a to-do
## Create a to do
Manually creates a to-do for the current user on an issue. If
there already exists a to-do for the user on that issue, status code `304` is
Manually creates a to do for the current user on an issue. If
there already exists a to do for the user on that issue, status code `304` is
returned.
```plaintext
......
doc/api/merge_requests.md
View file @ 69ab9e1c
......@@ -2085,10 +2085,10 @@ the `approvals_before_merge` parameter:
}
```
## Create a to-do
## Create a to do
Manually creates a to-do for the current user on a merge request.
If there already exists a to-do for the user on that merge request,
Manually creates a to do for the current user on a merge request.
If there already exists a to do for the user on that merge request,
status code `304` is returned.
```plaintext
......
doc/api/todos.md
View file @ 69ab9e1c
......@@ -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
---
# To-dos API
# To dos API
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/3188) in GitLab 8.10.
## Get a list of to-dos
## Get a list of to dos
Returns a list of to-dos. When no filter is applied, it returns all pending to-dos
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.
```plaintext
......@@ -25,8 +25,8 @@ Parameters:
| `author_id` | integer | no | The ID of an author |
| `project_id` | integer | no | The ID of a project |
| `group_id` | integer | no | The ID of a group |
| `state` | string | no | The state of the to-do. Can be either `pending` or `done` |
| `type` | string | no | The type of a to-do. Can be either `Issue`, `MergeRequest`, `DesignManagement::Design` or `AlertManagement::Alert` |
| `state` | string | no | The state of the to do. Can be either `pending` or `done` |
| `type` | string | no | The type of a to do. Can be either `Issue`, `MergeRequest`, `DesignManagement::Design` or `AlertManagement::Alert` |
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/todos"
......@@ -187,10 +187,10 @@ Example Response:
]
```
## Mark a to-do as done
## Mark a to do as done
Marks a single pending to-do given by its ID for the current user as done. The
to-do marked as done is returned in the response.
Marks a single pending to do given by its ID for the current user as done. The
to do marked as done is returned in the response.
```plaintext
POST /todos/:id/mark_as_done
......@@ -200,7 +200,7 @@ Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID of a to-do |
| `id` | integer | yes | The ID of a to do |
```shell
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:
}
```
## Mark all to-dos as done
## Mark all to dos as done
Marks all pending to-dos 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
POST /todos/mark_as_done
......
doc/operations/incident_management/alerts.md
View file @ 69ab9e1c
......@@ -188,7 +188,7 @@ GitLab supports only a single assignee per alert.
**{angle-double-right}** **Expand sidebar** to expand it.
1. In the right sidebar, locate the **Assignee**, and then select **Edit**.
From the 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.
GitLab creates a [to-do item](../../user/todos.md) for each user.
![Alert Details View Assignee(s)](./img/alert_todo_assignees_v13_1.png)
......@@ -211,13 +211,13 @@ The following actions will result in a system note:
![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.
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:
add a to do:
1. To display the list of current alerts, navigate to **Operations > Alerts**.
1. Select your desired alert to display its **Alert Management Details View**.
......@@ -225,9 +225,9 @@ add a to-do:
![Alert Details Add A To Do](./img/alert_detail_add_todo_v13_1.png)
Select the **To-Do** **{todo-done}** in the navigation bar to view your current to-do list.
Select the **To-Do List** **{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
......
doc/user/project/issues/design_management.md
View file @ 69ab9e1c
......@@ -224,7 +224,7 @@ Note that your resolved comment pins will disappear from the Design to free up s
However, if you need to revisit or find a resolved discussion, all of your resolved threads will be
available in the **Resolved Comment** area at the bottom of the right sidebar.
## Add To-Do for Designs
## Add to dos for designs
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/198439) in GitLab 13.4.
> - It's [deployed behind a feature flag](../../feature_flags.md), enabled by default.
......@@ -235,11 +235,11 @@ available in the **Resolved Comment** area at the bottom of the right sidebar.
CAUTION: **Warning:**
This feature might not be available to you. Check the **version history** note above for details.
Add a to-do for a design by clicking **Add a To-Do** on the design sidebar:
Add a to do for a design by clicking **Add a To-Do** on the design sidebar:
![To-Do button](img/design_todo_button_v13_4.png)
### Enable or disable the design To-Do button **(CORE ONLY)**
### Enable or disable the design to-do button **(CORE ONLY)**
The **Add a To-Do** button for Designs is under development but ready for production use. It is
deployed behind a feature flag that is **enabled by default**.
......
doc/user/project/issues/due_dates.md
View file @ 69ab9e1c
......@@ -46,7 +46,7 @@ the icon and the date colored red. You can sort issues by those that are
Due dates also appear in your [to-do list](../../todos.md).
![Issues with due dates in the to-dos](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
of the issue. Like the due date, the "day before the due date" is determined by the
......
doc/user/project/issues/issue_data_and_actions.md
View file @ 69ab9e1c
......@@ -242,7 +242,7 @@ and selecting either:
Also:
- You can mention a user or a group present in your GitLab instance with
`@username` or `@groupname` and they will be notified via To-Do items
`@username` or `@groupname` and they will be notified via to-do items
and email, unless they have [disabled all notifications](#notifications)
in their profile settings.
- Mentions for yourself (the current logged in user), will be highlighted
......
doc/user/project/quick_actions.md
View file @ 69ab9e1c
......@@ -39,7 +39,7 @@ The following quick actions are applicable to descriptions, discussions and thre
| `/copy_metadata <!merge_request>` | ✓ | ✓ | | Copy labels and milestone from another merge request in the project. |
| `/copy_metadata <#issue>` | ✓ | ✓ | | Copy labels and milestone from another issue in the project. |
| `/create_merge_request <branch name>` | ✓ | | | Create a new merge request starting from the current issue. |
| `/done` | ✓ | ✓ | ✓ | Mark To-Do as done. |
| `/done` | ✓ | ✓ | ✓ | Mark to do as done. |
| `/due <date>` | ✓ | | | Set due date. Examples of valid `<date>` include `in 2 days`, `this Friday` and `December 31st`. |
| `/duplicate <#issue>` | ✓ | | | Close this issue and mark as a duplicate of another issue. **(CORE)** Also, mark both as related. **(STARTER)** |
| `/epic <epic>` | ✓ | | | Add to epic `<epic>`. The `<epic>` value should be in the format of `&epic`, `group&epic`, or a URL to an epic. **(PREMIUM)** |
......@@ -74,7 +74,7 @@ The following quick actions are applicable to descriptions, discussions and thre
| `/tableflip <comment>` | ✓ | ✓ | ✓ | Append the comment with `(╯°□°)╯︵ ┻━┻`. |
| `/target_branch <local branch name>` | | ✓ | | Set target branch. |
| `/title <new title>` | ✓ | ✓ | ✓ | Change title. |
| `/todo` | ✓ | ✓ | ✓ | Add a To-Do. |
| `/todo` | ✓ | ✓ | ✓ | Add a to do. |
| `/unassign @user1 @user2` | ✓ | ✓ | | Remove specific assignees. **(STARTER)** |
| `/unassign` | ✓ | ✓ | | Remove all assignees. |
| `/unlabel ~label1 ~label2` or `/remove_label ~label1 ~label2` | ✓ | ✓ | ✓ | Remove all or specific labels. |
......
doc/user/todos.md
View file @ 69ab9e1c
......@@ -125,7 +125,7 @@ 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.
![A to-do in the To-Do List](img/todos_todo_list_item.png)
![A to do in the To-Do List](img/todos_todo_list_item.png)
You can also mark a to do item as done by clicking the **Mark as done** button
in the sidebar of an issue or merge request (or epic **(ULTIMATE)**).
......@@ -143,9 +143,9 @@ You can use the following types of filters with your To-Do List:
| ------- | ---------------------------------------------------------------- |
| Project | Filter by project. |
| 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)** |
| 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 previously
described [triggering actions](#what-triggers-a-to-do) include:
......
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7