Merge branch 'docs-to-do-style-edits' into 'master'

Docs: Update page with several style edits

See merge request gitlab-org/gitlab!42410

.gitlab/issue_templates/Security developer workflow.md

@@ -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
    * 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].
-   * 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.
 - [ ] If this issue requires less than `4` merge requests, post a message on the Security Release Tracking Issue and ping the Release Managers.
 

doc/README.md

@@ -126,7 +126,7 @@ The following documentation relates to the DevOps **Plan** stage:
 | [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.                                    |
 | [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">
   <a type="button" class="btn btn-default" href="#overview">
@@ -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.                                                    |
 | [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.                   |
-| [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.                                                |
 | [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.                                                                 |

doc/api/api_resources.md

@@ -151,7 +151,7 @@ The following API resources are available outside of project and group contexts
 | [Sidekiq metrics](sidekiq_metrics.md)              | `/sidekiq`                                                              |
 | [Suggestions](suggestions.md)                      | `/suggestions`                                                          |
 | [System hooks](system_hooks.md)                    | `/hooks`                                                                |
-| [Todos](todos.md)                                  | `/todos`                                                                |
+| [To-dos](todos.md)                                  | `/todos`                                                                |
 | [Users](users.md)                                  | `/users`                                                                |
 | [Validate `.gitlab-ci.yml` file](lint.md)          | `/lint`                                                                 |
 | [Version](version.md)                              | `/version`                                                              |

doc/api/epics.md

@@ -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"
 ```
 
-## Create a todo
+## Create a to-do
 
-Manually creates a todo for the current user on an epic. If
-there already exists a todo 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

@@ -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
-there already exists a todo 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

@@ -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.
-If there already exists a todo 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

@@ -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
 ---
 
-# Todos API
+# To-dos API
 
 > [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.
 
 ```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 todo. Can be either `pending` or `done` |
-| `type` | string | no | The type of a todo. 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 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
-todo 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 todo |
+| `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 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
 POST /todos/mark_as_done

doc/api/v3_to_v4.md

@@ -74,8 +74,8 @@ Below are the changes made between V3 and V4.
   - `POST /projects/:id/trigger/builds` to `POST /projects/:id/trigger/pipeline`
   - 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)
-- 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 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 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, 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)
 - 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)

doc/development/api_styleguide.md

@@ -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
   path is relative and does it contain `../../` relative traversal using
   `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'] }`
 
 - `Git SHA`:
@@ -249,7 +249,7 @@ most basic entity, with successive entities building upon that scope.
 
 The `with_api_entity_associations` scope will also [automatically preload
 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
 [this merge request](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/25711)

doc/development/documentation/styleguide.md

@@ -369,6 +369,7 @@ create an issue or an MR to propose a change to the user interface text.
   - milestones
   - reorder issues
   - runner, runners, shared runners
+  - a to-do, to-dos
 - *Some features are capitalized*, typically nouns naming GitLab-specific
   capabilities or tools. For example:
   - GitLab CI/CD

doc/operations/incident_management/alert_details.md

@@ -30,12 +30,12 @@ The **Overview** tab provides basic information about the alert:
 
 ![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.
 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.
 
@@ -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.
 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.
 
@@ -73,7 +73,7 @@ GitLab currently only supports a single assignee per alert.
    **{angle-double-right}** **Expand sidebar** to expand it.
 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
-   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)
 
@@ -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)
 
-### 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:
+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
    **{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
 
    ![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)
 
-### 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.
 
@@ -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
 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.
 

doc/university/README.md

@@ -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. [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. [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.5. Migrating from other Source Control

doc/user/admin_area/settings/external_authorization.md

@@ -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
 functionality that render cross-project data. That includes:
 
-- most pages under Dashboard (Activity, Milestones, Snippets, Assigned merge
-  requests, Assigned issues, Todos)
-- under a specific group (Activity, Contribution analytics, Issues, Issue boards,
-  Labels, Milestones, Merge requests)
-- Global and Group search will be disabled
+- Most pages under Dashboard (Activity, Milestones, Snippets, Assigned merge
+  requests, Assigned issues, To-Do List).
+- Under a specific group (Activity, Contribution analytics, Issues, Issue boards,
+  Labels, Milestones, Merge requests).
+- Global and Group search will be disabled.
 
 This is to prevent performing to many requests at once to the external
 authorization service.

doc/user/group/saml_sso/index.md

@@ -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.
 
-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"
 

doc/user/index.md

@@ -134,10 +134,10 @@ the best of GitLab Flavored Markdown in your threads, comments,
 issues and merge requests descriptions, and everywhere else GFM is
 supported.
 
-## Todos
+## To-Do List
 
-Never forget to reply to your collaborators. [GitLab Todos](todos.md)
-are a tool for working faster and more effectively with your team,
+Never forget to reply to your collaborators. [GitLab To-Do List](todos.md)
+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
 requests you're assigned to.
 

doc/user/profile/preferences.md

@@ -114,7 +114,7 @@ You have 8 options here that you can use for your default dashboard view:
 - Your projects' activity
 - Starred projects' activity
 - Your groups
-- Your [Todos](../todos.md)
+- Your [to-dos](../todos.md)
 - Assigned Issues
 - Assigned Merge Requests
 - Operations Dashboard **(PREMIUM)**

doc/user/project/issues/due_dates.md

@@ -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)
 
-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
 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

@@ -196,7 +196,7 @@ allowing many formatting options.
 ### Mentions
 
 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
 [notification settings](../../profile/notifications.md).