Commit f230765f authored by Mike Jang's avatar Mike Jang

Merge branch '276207-vale-substitutions-warning-part-03' into 'master'

Docs: clean up some Vale substitution warnings

See merge request gitlab-org/gitlab!51049
parents 6ec5b0eb 3859a2c1
...@@ -60,8 +60,8 @@ PUT /application/appearance ...@@ -60,8 +60,8 @@ PUT /application/appearance
| `favicon` | mixed | no | Instance favicon in `.ico` or `.png` format | `favicon` | mixed | no | Instance favicon in `.ico` or `.png` format
| `new_project_guidelines` | string | no | Markdown text shown on the new project page | `new_project_guidelines` | string | no | Markdown text shown on the new project page
| `profile_image_guidelines` | string | no | Markdown text shown on the profile page below Public Avatar | `profile_image_guidelines` | string | no | Markdown text shown on the profile page below Public Avatar
| `header_message` | string | no | Message within the system header bar | `header_message` | string | no | Message in the system header bar
| `footer_message` | string | no | Message within the system footer bar | `footer_message` | string | no | Message in the system footer bar
| `message_background_color` | string | no | Background color for the system header / footer bar | `message_background_color` | string | no | Background color for the system header / footer bar
| `message_font_color` | string | no | Font color for the system header / footer bar | `message_font_color` | string | no | Font color for the system header / footer bar
| `email_header_and_footer_enabled` | boolean | no | Add header and footer to all outgoing emails if enabled | `email_header_and_footer_enabled` | boolean | no | Add header and footer to all outgoing emails if enabled
......
...@@ -30,7 +30,7 @@ Parameters: ...@@ -30,7 +30,7 @@ Parameters:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|:----------|:--------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------| |:----------|:--------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------|
| `email` | string | yes | Public email address of the user. | | `email` | string | yes | Public email address of the user. |
| `size` | integer | no | Single pixel dimension (since images are squares). Only used for avatar lookups at `Gravatar` or at the configured `Libravatar` server. | | `size` | integer | no | Single pixel dimension (because images are squares). Only used for avatar lookups at `Gravatar` or at the configured `Libravatar` server. |
Example request: Example request:
......
...@@ -426,7 +426,7 @@ POST /projects/:id/boards/:board_id/lists ...@@ -426,7 +426,7 @@ POST /projects/:id/boards/:board_id/lists
NOTE: NOTE:
Label, assignee and milestone arguments are mutually exclusive, Label, assignee and milestone arguments are mutually exclusive,
that is, only one of them are accepted in a request. that is, only one of them are accepted in a request.
Check the [Issue Board docs](../user/project/issue_board.md) Check the [Issue Board documentation](../user/project/issue_board.md)
for more information regarding the required license for each list type. for more information regarding the required license for each list type.
```shell ```shell
......
...@@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/55978) in GitLab 11.8. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/55978) in GitLab 11.8.
This is the API docs of the [GitLab Container Registry](../user/packages/container_registry/index.md). This is the API documentation of the [GitLab Container Registry](../user/packages/container_registry/index.md).
## List registry repositories ## List registry repositories
......
...@@ -33,7 +33,7 @@ To use this in a [`script` definition](../ci/yaml/README.md#script) inside ...@@ -33,7 +33,7 @@ To use this in a [`script` definition](../ci/yaml/README.md#script) inside
- The `JOB-TOKEN` header with the GitLab-provided `CI_JOB_TOKEN` variable. - The `JOB-TOKEN` header with the GitLab-provided `CI_JOB_TOKEN` variable.
For example, the following job downloads the artifacts of the job with ID For example, the following job downloads the artifacts of the job with ID
`42`. Note that the command is wrapped into single quotes since it contains a `42`. Note that the command is wrapped into single quotes because it contains a
colon (`:`): colon (`:`):
```yaml ```yaml
...@@ -99,7 +99,7 @@ To use this in a [`script` definition](../ci/yaml/README.md#script) inside ...@@ -99,7 +99,7 @@ To use this in a [`script` definition](../ci/yaml/README.md#script) inside
- The `JOB-TOKEN` header with the GitLab-provided `CI_JOB_TOKEN` variable. - The `JOB-TOKEN` header with the GitLab-provided `CI_JOB_TOKEN` variable.
For example, the following job downloads the artifacts of the `test` job For example, the following job downloads the artifacts of the `test` job
of the `master` branch. Note that the command is wrapped into single quotes of the `master` branch. Note that the command is wrapped into single quotes
since it contains a colon (`:`): because it contains a colon (`:`):
```yaml ```yaml
artifact_download: artifact_download:
...@@ -130,7 +130,7 @@ Possible response status codes: ...@@ -130,7 +130,7 @@ Possible response status codes:
> Introduced in GitLab 10.0 > Introduced in GitLab 10.0
Download a single artifact file from a job with a specified ID from within Download a single artifact file from a job with a specified ID from inside
the job's artifacts zipped archive. The file is extracted from the archive and the job's artifacts zipped archive. The file is extracted from the archive and
streamed to the client. streamed to the client.
...@@ -165,7 +165,7 @@ Possible response status codes: ...@@ -165,7 +165,7 @@ Possible response status codes:
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/23538) in GitLab 11.5. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/23538) in GitLab 11.5.
Download a single artifact file for a specific job of the latest successful Download a single artifact file for a specific job of the latest successful
pipeline for the given reference name from within the job's artifacts archive. pipeline for the given reference name from inside the job's artifacts archive.
The file is extracted from the archive and streamed to the client. The file is extracted from the archive and streamed to the client.
In [GitLab 13.5](https://gitlab.com/gitlab-org/gitlab/-/issues/201784) and later, artifacts In [GitLab 13.5](https://gitlab.com/gitlab-org/gitlab/-/issues/201784) and later, artifacts
......
...@@ -468,7 +468,7 @@ DELETE /projects/:id/members/:user_id ...@@ -468,7 +468,7 @@ DELETE /projects/:id/members/:user_id
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](README.md#namespaced-path-encoding) owned by the authenticated user |
| `user_id` | integer | yes | The user ID of the member | | `user_id` | integer | yes | The user ID of the member |
| `unassign_issuables` | boolean | false | Flag indicating if the removed member should be unassigned from any issues or merge requests within given group or project | | `unassign_issuables` | boolean | false | Flag indicating if the removed member should be unassigned from any issues or merge requests inside a given group or project |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members/:user_id" curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members/:user_id"
......
...@@ -19,12 +19,12 @@ documentation. This functionality is based on the ...@@ -19,12 +19,12 @@ documentation. This functionality is based on the
GitLab currently supports the following authorization flows: GitLab currently supports the following authorization flows:
- **Authorization code with [Proof Key for Code Exchange (PKCE)](https://tools.ietf.org/html/rfc7636):** - **Authorization code with [Proof Key for Code Exchange (PKCE)](https://tools.ietf.org/html/rfc7636):**
Most secure. Without PKCE, you'd have to include client secrets on mobile clients, Most secure. Without PKCE, you'd have to include client secrets on mobile clients,
and is recommended for both client and server aoos. and is recommended for both client and server aoos.
- **Authorization code:** Secure and common flow. Recommended option for secure - **Authorization code:** Secure and common flow. Recommended option for secure
server-side apps. server-side apps.
- **Implicit grant:** Originally designed for user-agent only apps, such as - **Implicit grant:** Originally designed for user-agent only apps, such as
single page web apps running on GitLab Pages). single page web apps running on GitLab Pages).
The [IETF](https://tools.ietf.org/html/draft-ietf-oauth-security-topics-09#section-2.1.2) The [IETF](https://tools.ietf.org/html/draft-ietf-oauth-security-topics-09#section-2.1.2)
recommends against Implicit grant flow. recommends against Implicit grant flow.
...@@ -159,7 +159,7 @@ The authorization code flow is essentially the same as ...@@ -159,7 +159,7 @@ The authorization code flow is essentially the same as
You should then use `code` to request an access token. You should then use `code` to request an access token.
1. Once you have the authorization code you can request an `access_token` using the 1. After you have the authorization code you can request an `access_token` using the
code. You can do that by using any HTTP client. In the following example, code. You can do that by using any HTTP client. In the following example,
we are using Ruby's `rest-client`: we are using Ruby's `rest-client`:
...@@ -189,7 +189,7 @@ You can now make requests to the API with the access token returned. ...@@ -189,7 +189,7 @@ You can now make requests to the API with the access token returned.
### Implicit grant flow ### Implicit grant flow
NOTE: NOTE:
For a detailed flow diagram, see the [RFC specification](https://tools.ietf.org/html/rfc6749#section-4.2). For a detailed flow diagram, see the [RFC specification](https://tools.ietf.org/html/rfc6749#section-4.2).
WARNING: WARNING:
The Implicit grant flow is inherently insecure. The IETF plans to remove it in The Implicit grant flow is inherently insecure. The IETF plans to remove it in
......
...@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Packages API # Packages API
This is the API docs of [GitLab Packages](../administration/packages/index.md). This is the API documentation of [GitLab Packages](../administration/packages/index.md).
## List packages ## List packages
...@@ -68,7 +68,7 @@ Example response: ...@@ -68,7 +68,7 @@ Example response:
] ]
``` ```
By default, the `GET` request returns 20 results, since the API is [paginated](README.md#pagination). By default, the `GET` request returns 20 results, because the API is [paginated](README.md#pagination).
### Within a group ### Within a group
...@@ -159,7 +159,7 @@ Example response: ...@@ -159,7 +159,7 @@ Example response:
] ]
``` ```
By default, the `GET` request returns 20 results, since the API is [paginated](README.md#pagination). By default, the `GET` request returns 20 results, because the API is [paginated](README.md#pagination).
The `_links` object contains the following properties: The `_links` object contains the following properties:
...@@ -316,7 +316,7 @@ Example response: ...@@ -316,7 +316,7 @@ Example response:
] ]
``` ```
By default, the `GET` request returns 20 results, since the API is [paginated](README.md#pagination). By default, the `GET` request returns 20 results, because the API is [paginated](README.md#pagination).
## Delete a project package ## Delete a project package
......
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