Commit 878b7940 authored by Evan Read's avatar Evan Read

Merge branch 'docs-alert-boxes-2' into 'master'

Expand vale rule for alert box style

See merge request gitlab-org/gitlab!37033
parents de115779 fd5bc18b
...@@ -10,4 +10,4 @@ link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert ...@@ -10,4 +10,4 @@ link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert
level: error level: error
scope: raw scope: raw
raw: raw:
- 'NOTE: \*\*[^:]*\*\*' - '(NOTE|TIP|CAUTION|DANGER): \*\*[^:]*\*\*'
...@@ -126,7 +126,7 @@ these epics/issues: ...@@ -126,7 +126,7 @@ these epics/issues:
- [Unreplicated Data Types](https://gitlab.com/groups/gitlab-org/-/epics/893) - [Unreplicated Data Types](https://gitlab.com/groups/gitlab-org/-/epics/893)
- [Verify all replicated data](https://gitlab.com/groups/gitlab-org/-/epics/1430) - [Verify all replicated data](https://gitlab.com/groups/gitlab-org/-/epics/1430)
DANGER: **DANGER** DANGER: **Danger:**
Features not on this list, or with **No** in the **Replicated** column, Features not on this list, or with **No** in the **Replicated** column,
are not replicated on the **secondary** node. Failing over without manually are not replicated on the **secondary** node. Failing over without manually
replicating data from those features will cause the data to be **lost**. replicating data from those features will cause the data to be **lost**.
......
...@@ -452,13 +452,13 @@ to start again from scratch, there are a few steps that can help you: ...@@ -452,13 +452,13 @@ to start again from scratch, there are a few steps that can help you:
chown git:git /var/opt/gitlab/git-data/repositories chown git:git /var/opt/gitlab/git-data/repositories
``` ```
TIP: **Tip** TIP: **Tip:**
You may want to remove the `/var/opt/gitlab/git-data/repositories.old` in the future You may want to remove the `/var/opt/gitlab/git-data/repositories.old` in the future
as soon as you confirmed that you don't need it anymore, to save disk space. as soon as you confirmed that you don't need it anymore, to save disk space.
1. _(Optional)_ Rename other data folders and create new ones 1. _(Optional)_ Rename other data folders and create new ones
CAUTION: **Caution**: CAUTION: **Caution:**
You may still have files on the **secondary** node that have been removed from **primary** node but You may still have files on the **secondary** node that have been removed from **primary** node but
removal have not been reflected. If you skip this step, they will never be removed removal have not been reflected. If you skip this step, they will never be removed
from this Geo node. from this Geo node.
......
...@@ -700,7 +700,8 @@ Particular attention should be shown to: ...@@ -700,7 +700,8 @@ Particular attention should be shown to:
1. Disable the default Gitaly service running on the GitLab host. It won't be needed 1. Disable the default Gitaly service running on the GitLab host. It won't be needed
as GitLab will connect to the configured cluster. as GitLab will connect to the configured cluster.
CAUTION: **CAUTION** If you have existing data stored on the default Gitaly storage, CAUTION: **Caution:**
If you have existing data stored on the default Gitaly storage,
you should [migrate the data your Praefect storage first](#migrating-existing-repositories-to-praefect). you should [migrate the data your Praefect storage first](#migrating-existing-repositories-to-praefect).
```ruby ```ruby
......
...@@ -260,7 +260,7 @@ clear it. ...@@ -260,7 +260,7 @@ clear it.
To clear all exclusive leases: To clear all exclusive leases:
DANGER: **DANGER**: DANGER: **Danger:**
Don't run it while GitLab or Sidekiq is running Don't run it while GitLab or Sidekiq is running
```shell ```shell
......
...@@ -38,7 +38,7 @@ are paginated. ...@@ -38,7 +38,7 @@ are paginated.
Read more on [pagination](README.md#pagination). Read more on [pagination](README.md#pagination).
CAUTION: **Deprecation** CAUTION: **Deprecation:**
> `reference` attribute in response is deprecated in favour of `references`. > `reference` attribute in response is deprecated in favour of `references`.
> Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354) > Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354)
......
...@@ -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/-/issues/9566) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.5. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9566) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.5.
CAUTION: **Deprecation** CAUTION: **Deprecation:**
This API is deprecated and [scheduled for removal in GitLab 14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/213369). This API is deprecated and [scheduled for removal in GitLab 14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/213369).
The API for creating, updating, reading and deleting Feature Flag Specs. The API for creating, updating, reading and deleting Feature Flag Specs.
......
...@@ -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/-/issues/9566) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.5. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9566) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.5.
CAUTION: **Deprecation** CAUTION: **Deprecation:**
This API is deprecated and [scheduled for removal in GitLab 14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/213369). Use [this API](feature_flags.md) instead. This API is deprecated and [scheduled for removal in GitLab 14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/213369). Use [this API](feature_flags.md) instead.
API for accessing resources of [GitLab Feature Flags](../operations/feature_flags.md). API for accessing resources of [GitLab Feature Flags](../operations/feature_flags.md).
......
...@@ -16,7 +16,7 @@ are paginated. ...@@ -16,7 +16,7 @@ are paginated.
Read more on [pagination](README.md#pagination). Read more on [pagination](README.md#pagination).
CAUTION: **Deprecation** CAUTION: **Deprecation:**
> `reference` attribute in response is deprecated in favour of `references`. > `reference` attribute in response is deprecated in favour of `references`.
> Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354) > Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354)
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
Every API call to merge requests must be authenticated. Every API call to merge requests must be authenticated.
CAUTION: **Deprecation** CAUTION: **Deprecation:**
> `reference` attribute in response is deprecated in favour of `references`. > `reference` attribute in response is deprecated in favour of `references`.
> Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354) > Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354)
......
...@@ -80,7 +80,7 @@ GET /groups/:id/packages ...@@ -80,7 +80,7 @@ GET /groups/:id/packages
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/packages?exclude_subgroups=true" curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/packages?exclude_subgroups=true"
``` ```
CAUTION: **Deprecation** CAUTION: **Deprecation:**
> The `build_info` attribute in the response is deprecated in favour of `pipeline`. > The `build_info` attribute in the response is deprecated in favour of `pipeline`.
> Introduced [GitLab 12.10](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28040). > Introduced [GitLab 12.10](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28040).
...@@ -165,7 +165,7 @@ GET /projects/:id/packages/:package_id ...@@ -165,7 +165,7 @@ GET /projects/:id/packages/:package_id
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/packages/:package_id" curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/packages/:package_id"
``` ```
CAUTION: **Deprecation** CAUTION: **Deprecation:**
> The `build_info` attribute in the response is deprecated in favour of `pipeline`. > The `build_info` attribute in the response is deprecated in favour of `pipeline`.
> Introduced [GitLab 12.10](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28040). > Introduced [GitLab 12.10](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28040).
......
...@@ -124,7 +124,7 @@ The environment `name` and `url` is exposed in various places ...@@ -124,7 +124,7 @@ The environment `name` and `url` is exposed in various places
within GitLab. Each time a job that has an environment specified within GitLab. Each time a job that has an environment specified
succeeds, a deployment is recorded, along with the Git SHA, and environment name. succeeds, a deployment is recorded, along with the Git SHA, and environment name.
CAUTION: **Caution**: CAUTION: **Caution:**
Some characters are not allowed in environment names. Use only letters, Some characters are not allowed in environment names. Use only letters,
numbers, spaces, and `-`, `_`, `/`, `{`, `}`, or `.`. Also, it must not start nor end with `/`. numbers, spaces, and `-`, `_`, `/`, `{`, `}`, or `.`. Also, it must not start nor end with `/`.
......
...@@ -60,7 +60,7 @@ To communicate with Vault, you can use either its CLI client or perform API requ ...@@ -60,7 +60,7 @@ To communicate with Vault, you can use either its CLI client or perform API requ
## Example ## Example
CAUTION: **Caution**: CAUTION: **Caution:**
JWTs are credentials, which can grant access to resources. Be careful where you paste them! JWTs are credentials, which can grant access to resources. Be careful where you paste them!
Let's say you have the passwords for your staging and production databases stored in a Vault server that is running on `http://vault.example.com:8200`. Your staging password is `pa$$w0rd` and your production password is `real-pa$$w0rd`. Let's say you have the passwords for your staging and production databases stored in a Vault server that is running on `http://vault.example.com:8200`. Your staging password is `pa$$w0rd` and your production password is `real-pa$$w0rd`.
...@@ -156,7 +156,7 @@ Combined with GitLab's [protected branches](../../../user/project/protected_bran ...@@ -156,7 +156,7 @@ Combined with GitLab's [protected branches](../../../user/project/protected_bran
For the full list of options, see Vault's [Create Role documentation](https://www.vaultproject.io/api/auth/jwt#create-role). For the full list of options, see Vault's [Create Role documentation](https://www.vaultproject.io/api/auth/jwt#create-role).
CAUTION: **Caution**: CAUTION: **Caution:**
Always restrict your roles to project or namespace by using one of the provided claims (e.g. `project_id` or `namespace_id`). Otherwise any JWT generated by this instance may be allowed to authenticate using this role. Always restrict your roles to project or namespace by using one of the provided claims (e.g. `project_id` or `namespace_id`). Otherwise any JWT generated by this instance may be allowed to authenticate using this role.
Now, configure the JWT Authentication method: Now, configure the JWT Authentication method:
......
...@@ -1181,7 +1181,7 @@ job: ...@@ -1181,7 +1181,7 @@ job:
- If the pipeline is a scheduled pipeline, the job is **not** be added to the pipeline. - If the pipeline is a scheduled pipeline, the job is **not** be added to the pipeline.
- In **all other cases**, the job is added to the pipeline, with `when: on_success`. - In **all other cases**, the job is added to the pipeline, with `when: on_success`.
CAUTION: **Caution** CAUTION: **Caution:**
If you use `when: on_success`, `always`, or `delayed` as the final rule, two If you use `when: on_success`, `always`, or `delayed` as the final rule, two
simultaneous pipelines may start. Both push pipelines and merge request pipelines can simultaneous pipelines may start. Both push pipelines and merge request pipelines can
be triggered by the same event (a push to the source branch for an open merge request). be triggered by the same event (a push to the source branch for an open merge request).
...@@ -1569,7 +1569,7 @@ and must be surrounded by `/`. ...@@ -1569,7 +1569,7 @@ and must be surrounded by `/`.
So `issue-/.*/` won't work to match all tag names or branch names So `issue-/.*/` won't work to match all tag names or branch names
that begin with `issue-`. that begin with `issue-`.
TIP: **Tip** TIP: **Tip:**
Use anchors `^` and `$` to avoid the regular expression Use anchors `^` and `$` to avoid the regular expression
matching only a substring of the tag name or branch name. matching only a substring of the tag name or branch name.
For example, `/^issue-.*$/` is equivalent to `/^issue-/`, For example, `/^issue-.*$/` is equivalent to `/^issue-/`,
......
...@@ -98,7 +98,7 @@ for clarity. ...@@ -98,7 +98,7 @@ for clarity.
To see the improvements planned, check the To see the improvements planned, check the
[global nav epic](https://gitlab.com/groups/gitlab-com/-/epics/21). [global nav epic](https://gitlab.com/groups/gitlab-com/-/epics/21).
CAUTION: **Attention!** NOTE: **Note:**
**Do not** [add items](#adding-new-items) to the global nav without **Do not** [add items](#adding-new-items) to the global nav without
the consent of one of the technical writers. the consent of one of the technical writers.
...@@ -275,7 +275,7 @@ and the following syntax rules. ...@@ -275,7 +275,7 @@ and the following syntax rules.
an "information" icon on the nav to make the user aware that the feature is an "information" icon on the nav to make the user aware that the feature is
EE-only. EE-only.
DANGER: **Important!** CAUTION: **Caution:**
All links present on the data file must end in `.html`, not `.md`. Do not All links present on the data file must end in `.html`, not `.md`. Do not
start any relative link with a forward slash `/`. start any relative link with a forward slash `/`.
......
...@@ -111,7 +111,7 @@ located in the [Dockerfiles directory](https://gitlab.com/gitlab-org/gitlab-docs ...@@ -111,7 +111,7 @@ located in the [Dockerfiles directory](https://gitlab.com/gitlab-org/gitlab-docs
If you need to rebuild the Docker images immediately (must have maintainer level permissions): If you need to rebuild the Docker images immediately (must have maintainer level permissions):
CAUTION: **Caution** CAUTION: **Caution:**
If you change the dockerfile configuration and rebuild the images, you can break the master If you change the dockerfile configuration and rebuild the images, you can break the master
pipeline in the main `gitlab` repository as well as in `gitlab-docs`. Create an image with pipeline in the main `gitlab` repository as well as in `gitlab-docs`. Create an image with
a different name first and test it to ensure you do not break the pipelines. a different name first and test it to ensure you do not break the pipelines.
......
...@@ -173,7 +173,7 @@ You can filter the selection dropdown by writing part of the namespace or projec ...@@ -173,7 +173,7 @@ You can filter the selection dropdown by writing part of the namespace or projec
NOTE: **Note:** NOTE: **Note:**
If no namespaces or projects are selected, no Elasticsearch indexing will take place. If no namespaces or projects are selected, no Elasticsearch indexing will take place.
CAUTION: **Warning**: CAUTION: **Warning:**
If you have already indexed your instance, you will have to regenerate the index in order to delete all existing data If you have already indexed your instance, you will have to regenerate the index in order to delete all existing data
for filtering to work correctly. To do this run the Rake tasks `gitlab:elastic:recreate_index` and for filtering to work correctly. To do this run the Rake tasks `gitlab:elastic:recreate_index` and
`gitlab:elastic:clear_index_status`. Afterwards, removing a namespace or a project from the list will delete the data `gitlab:elastic:clear_index_status`. Afterwards, removing a namespace or a project from the list will delete the data
...@@ -240,7 +240,7 @@ Indexing can be performed using Rake tasks. ...@@ -240,7 +240,7 @@ Indexing can be performed using Rake tasks.
#### Indexing small instances #### Indexing small instances
CAUTION: **Warning**: CAUTION: **Warning:**
This will delete your existing indexes. This will delete your existing indexes.
If the database size is less than 500 MiB, and the size of all hosted repos is less than 5 GiB: If the database size is less than 500 MiB, and the size of all hosted repos is less than 5 GiB:
...@@ -260,7 +260,7 @@ If the database size is less than 500 MiB, and the size of all hosted repos is l ...@@ -260,7 +260,7 @@ If the database size is less than 500 MiB, and the size of all hosted repos is l
#### Indexing large instances #### Indexing large instances
CAUTION: **Warning**: CAUTION: **Warning:**
Performing asynchronous indexing will generate a lot of Sidekiq jobs. Performing asynchronous indexing will generate a lot of Sidekiq jobs.
Make sure to prepare for this task by having a [Scalable and Highly Available Setup](README.md) Make sure to prepare for this task by having a [Scalable and Highly Available Setup](README.md)
or creating [extra Sidekiq processes](../administration/operations/extra_sidekiq_processes.md) or creating [extra Sidekiq processes](../administration/operations/extra_sidekiq_processes.md)
...@@ -632,7 +632,7 @@ Here are some common pitfalls and how to overcome them: ...@@ -632,7 +632,7 @@ Here are some common pitfalls and how to overcome them:
**For a single node Elasticsearch cluster the functional cluster health status will be yellow** (will never be green) because the primary shard is allocated but replicas can not be as there is no other node to which Elasticsearch can assign a replica. This also applies if you are using the **For a single node Elasticsearch cluster the functional cluster health status will be yellow** (will never be green) because the primary shard is allocated but replicas can not be as there is no other node to which Elasticsearch can assign a replica. This also applies if you are using the
[Amazon Elasticsearch](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-handling-errors.html#aes-handling-errors-yellow-cluster-status) service. [Amazon Elasticsearch](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-handling-errors.html#aes-handling-errors-yellow-cluster-status) service.
CAUTION: **Warning**: Setting the number of replicas to `0` is not something that we recommend (this is not allowed in the GitLab Elasticsearch Integration menu). If you are planning to add more Elasticsearch nodes (for a total of more than 1 Elasticsearch) the number of replicas will need to be set to an integer value larger than `0`. Failure to do so will result in lack of redundancy (losing one node will corrupt the index). CAUTION: **Warning:** Setting the number of replicas to `0` is not something that we recommend (this is not allowed in the GitLab Elasticsearch Integration menu). If you are planning to add more Elasticsearch nodes (for a total of more than 1 Elasticsearch) the number of replicas will need to be set to an integer value larger than `0`. Failure to do so will result in lack of redundancy (losing one node will corrupt the index).
If you have a **hard requirement to have a green status for your single node Elasticsearch cluster**, please make sure you understand the risks outlined in the previous paragraph and then simply run the following query to set the number of replicas to `0`(the cluster will no longer try to create any shard replicas): If you have a **hard requirement to have a green status for your single node Elasticsearch cluster**, please make sure you understand the risks outlined in the previous paragraph and then simply run the following query to set the number of replicas to `0`(the cluster will no longer try to create any shard replicas):
......
...@@ -218,7 +218,7 @@ include: ...@@ -218,7 +218,7 @@ include:
See the [Auto DevOps template](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Auto-DevOps.gitlab-ci.yml) for information on available jobs. See the [Auto DevOps template](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Auto-DevOps.gitlab-ci.yml) for information on available jobs.
CAUTION: **Deprecation** CAUTION: **Deprecation:**
Auto DevOps templates using the [`only`](../../ci/yaml/README.md#onlyexcept-basic) or Auto DevOps templates using the [`only`](../../ci/yaml/README.md#onlyexcept-basic) or
[`except`](../../ci/yaml/README.md#onlyexcept-basic) syntax will switch [`except`](../../ci/yaml/README.md#onlyexcept-basic) syntax will switch
to the [`rules`](../../ci/yaml/README.md#rules) syntax, starting in to the [`rules`](../../ci/yaml/README.md#rules) syntax, starting in
...@@ -243,7 +243,7 @@ postgres://user:password@postgres-host:postgres-port/postgres-database ...@@ -243,7 +243,7 @@ postgres://user:password@postgres-host:postgres-port/postgres-database
### Upgrading PostgresSQL ### Upgrading PostgresSQL
CAUTION: **Deprecation** CAUTION: **Deprecation:**
The variable `AUTO_DEVOPS_POSTGRES_CHANNEL` that controls default provisioned The variable `AUTO_DEVOPS_POSTGRES_CHANNEL` that controls default provisioned
PostgreSQL was changed to `2` in [GitLab 13.0](https://gitlab.com/gitlab-org/gitlab/-/issues/210499). PostgreSQL was changed to `2` in [GitLab 13.0](https://gitlab.com/gitlab-org/gitlab/-/issues/210499).
To keep using the old PostgreSQL, set the `AUTO_DEVOPS_POSTGRES_CHANNEL` variable to To keep using the old PostgreSQL, set the `AUTO_DEVOPS_POSTGRES_CHANNEL` variable to
......
...@@ -372,7 +372,7 @@ as it attempts to fetch the image using `CI_REGISTRY_PASSWORD`. ...@@ -372,7 +372,7 @@ as it attempts to fetch the image using `CI_REGISTRY_PASSWORD`.
> - Support for deploying a PostgreSQL version that supports Kubernetes 1.16+ was [introduced](https://gitlab.com/gitlab-org/cluster-integration/auto-deploy-image/-/merge_requests/49) in GitLab 12.9. > - Support for deploying a PostgreSQL version that supports Kubernetes 1.16+ was [introduced](https://gitlab.com/gitlab-org/cluster-integration/auto-deploy-image/-/merge_requests/49) in GitLab 12.9.
> - Supported out of the box for new deployments as of GitLab 13.0. > - Supported out of the box for new deployments as of GitLab 13.0.
CAUTION: **Deprecation** CAUTION: **Deprecation:**
The default value for the `deploymentApiVersion` setting was changed from The default value for the `deploymentApiVersion` setting was changed from
`extensions/v1beta` to `apps/v1` in [GitLab 13.0](https://gitlab.com/gitlab-org/charts/auto-deploy-app/-/issues/47). `extensions/v1beta` to `apps/v1` in [GitLab 13.0](https://gitlab.com/gitlab-org/charts/auto-deploy-app/-/issues/47).
......
...@@ -462,7 +462,7 @@ It is currently not possible to rename a namespace if it contains a ...@@ -462,7 +462,7 @@ It is currently not possible to rename a namespace if it contains a
project with [Container Registry](../packages/container_registry/index.md) tags, project with [Container Registry](../packages/container_registry/index.md) tags,
because the project cannot be moved. because the project cannot be moved.
TIP: **TIP:** TIP: **Tip:**
If you want to retain ownership over the original namespace and If you want to retain ownership over the original namespace and
protect the URL redirects, then instead of changing a group's path or renaming a protect the URL redirects, then instead of changing a group's path or renaming a
username, you can create a new group and transfer projects to it. username, you can create a new group and transfer projects to it.
......
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