Commit 791dda51 authored by Evan Read's avatar Evan Read

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

Expand vale rule for alert box capitalization

See merge request gitlab-org/gitlab!37035
parents de5eb488 b0d75b5a
...@@ -10,4 +10,6 @@ link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert ...@@ -10,4 +10,6 @@ link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert
level: error level: error
scope: raw scope: raw
raw: raw:
- '(NOTE|TIP|CAUTION|DANGER): \*\*[^:]*\*\*' - '((NOTE|TIP|CAUTION|DANGER): \*\*[^:]*\*\*)|'
- '((NOTE: \*\*NOTE:\*\*)|(TIP: \*\*TIP:\*\*)|(CAUTION: \*\*CAUTION:\*\*)|(DANGER: \*\*DANGER:\*\*))|'
- '((NOTE: \*\*note:\*\*)|(TIP: \*\*tip:\*\*)|(CAUTION: \*\*caution:\*\*)|(DANGER: \*\*danger:\*\*))'
...@@ -357,7 +357,7 @@ GitLab syncs the `admin_group`. ...@@ -357,7 +357,7 @@ GitLab syncs the `admin_group`.
#### Sync all groups **(STARTER ONLY)** #### Sync all groups **(STARTER ONLY)**
NOTE: **NOTE:** NOTE: **Note:**
To sync all groups manually when debugging is unnecessary, [use the Rake To sync all groups manually when debugging is unnecessary, [use the Rake
task](../../raketasks/ldap.md#run-a-group-sync-starter-only) instead. task](../../raketasks/ldap.md#run-a-group-sync-starter-only) instead.
...@@ -653,7 +653,7 @@ adfind -h ad.example.org:636 -ssl -u "CN=GitLabSRV,CN=Users,DC=GitLab,DC=org" -u ...@@ -653,7 +653,7 @@ adfind -h ad.example.org:636 -ssl -u "CN=GitLabSRV,CN=Users,DC=GitLab,DC=org" -u
### Rails console ### Rails console
CAUTION: **CAUTION:** CAUTION: **Caution:**
Please note that it is very easy to create, read, modify, and destroy data on the Please note that it is very easy to create, read, modify, and destroy data on the
rails console, so please be sure to run commands exactly as listed. rails console, so please be sure to run commands exactly as listed.
......
...@@ -286,7 +286,7 @@ application server, or a Gitaly node. ...@@ -286,7 +286,7 @@ application server, or a Gitaly node.
so we use `default` here as well. This cluster has three Gitaly nodes `gitaly-1`, so we use `default` here as well. This cluster has three Gitaly nodes `gitaly-1`,
`gitaly-2`, and `gitaly-3`, which will be replicas of each other. `gitaly-2`, and `gitaly-3`, which will be replicas of each other.
CAUTION: **CAUTION:** If you have data on an already existing storage called CAUTION: **Caution:** If you have data on an already existing storage called
`default`, you should configure the virtual storage with another name and `default`, you should configure the virtual storage with another name and
[migrate the data to the Praefect storage](#migrating-existing-repositories-to-praefect) [migrate the data to the Praefect storage](#migrating-existing-repositories-to-praefect)
afterwards. afterwards.
......
...@@ -113,14 +113,14 @@ Nodes running GitLab-bundled Consul should be: ...@@ -113,14 +113,14 @@ Nodes running GitLab-bundled Consul should be:
- Members of a healthy cluster prior to upgrading the Omnibus GitLab package. - Members of a healthy cluster prior to upgrading the Omnibus GitLab package.
- Upgraded one node at a time. - Upgraded one node at a time.
NOTE: **NOTE:** NOTE: **Note:**
Running `curl http://127.0.0.1:8500/v1/health/state/critical` from any Consul node will identify existing health issues in the cluster. The command will return an empty array if the cluster is healthy. Running `curl http://127.0.0.1:8500/v1/health/state/critical` from any Consul node will identify existing health issues in the cluster. The command will return an empty array if the cluster is healthy.
Consul clusters communicate using the raft protocol. If the current leader goes offline, there needs to be a leader election. A leader node must exist to facilitate synchronization across the cluster. If too many nodes go offline at the same time, the cluster will lose quorum and not elect a leader due to [broken consensus](https://www.consul.io/docs/internals/consensus.html). Consul clusters communicate using the raft protocol. If the current leader goes offline, there needs to be a leader election. A leader node must exist to facilitate synchronization across the cluster. If too many nodes go offline at the same time, the cluster will lose quorum and not elect a leader due to [broken consensus](https://www.consul.io/docs/internals/consensus.html).
Consult the [troubleshooting section](#troubleshooting) if the cluster is not able to recover after the upgrade. The [outage recovery](#outage-recovery) may be of particular interest. Consult the [troubleshooting section](#troubleshooting) if the cluster is not able to recover after the upgrade. The [outage recovery](#outage-recovery) may be of particular interest.
NOTE: **NOTE:** NOTE: **Note:**
GitLab only uses Consul to store transient data that is easily regenerated. If the bundled Consul was not used by any process other than GitLab itself, then [rebuilding the cluster from scratch](#recreate-from-scratch) is fine. GitLab only uses Consul to store transient data that is easily regenerated. If the bundled Consul was not used by any process other than GitLab itself, then [rebuilding the cluster from scratch](#recreate-from-scratch) is fine.
## Troubleshooting ## Troubleshooting
......
...@@ -163,7 +163,7 @@ _The artifacts are stored by default in ...@@ -163,7 +163,7 @@ _The artifacts are stored by default in
gitlab-rake gitlab:artifacts:migrate gitlab-rake gitlab:artifacts:migrate
``` ```
CAUTION: **CAUTION:** CAUTION: **Caution:**
JUnit test report artifact (`junit.xml.gz`) migration JUnit test report artifact (`junit.xml.gz`) migration
[is not supported](https://gitlab.com/gitlab-org/gitlab/-/issues/27698) [is not supported](https://gitlab.com/gitlab-org/gitlab/-/issues/27698)
by the `gitlab:artifacts:migrate` script. by the `gitlab:artifacts:migrate` script.
...@@ -196,7 +196,7 @@ _The artifacts are stored by default in ...@@ -196,7 +196,7 @@ _The artifacts are stored by default in
sudo -u git -H bundle exec rake gitlab:artifacts:migrate RAILS_ENV=production sudo -u git -H bundle exec rake gitlab:artifacts:migrate RAILS_ENV=production
``` ```
CAUTION: **CAUTION:** CAUTION: **Caution:**
JUnit test report artifact (`junit.xml.gz`) migration JUnit test report artifact (`junit.xml.gz`) migration
[is not supported](https://gitlab.com/gitlab-org/gitlab/-/issues/27698) [is not supported](https://gitlab.com/gitlab-org/gitlab/-/issues/27698)
by the `gitlab:artifacts:migrate` script. by the `gitlab:artifacts:migrate` script.
...@@ -434,7 +434,7 @@ the number you want. ...@@ -434,7 +434,7 @@ the number you want.
#### Delete job artifacts from jobs completed before a specific date #### Delete job artifacts from jobs completed before a specific date
CAUTION: **CAUTION:** CAUTION: **Caution:**
These commands remove data permanently from the database and from disk. We These commands remove data permanently from the database and from disk. We
highly recommend running them only under the guidance of a Support Engineer, or highly recommend running them only under the guidance of a Support Engineer, or
running them in a test environment with a backup of the instance ready to be running them in a test environment with a backup of the instance ready to be
...@@ -460,7 +460,7 @@ If you need to manually remove job artifacts associated with multiple jobs while ...@@ -460,7 +460,7 @@ If you need to manually remove job artifacts associated with multiple jobs while
1. Delete job artifacts older than a specific date: 1. Delete job artifacts older than a specific date:
NOTE: **NOTE:** NOTE: **Note:**
This step will also erase artifacts that users have chosen to This step will also erase artifacts that users have chosen to
["keep"](../ci/pipelines/job_artifacts.md#browsing-artifacts). ["keep"](../ci/pipelines/job_artifacts.md#browsing-artifacts).
...@@ -481,7 +481,7 @@ If you need to manually remove job artifacts associated with multiple jobs while ...@@ -481,7 +481,7 @@ If you need to manually remove job artifacts associated with multiple jobs while
#### Delete job artifacts and logs from jobs completed before a specific date #### Delete job artifacts and logs from jobs completed before a specific date
CAUTION: **CAUTION:** CAUTION: **Caution:**
These commands remove data permanently from the database and from disk. We These commands remove data permanently from the database and from disk. We
highly recommend running them only under the guidance of a Support Engineer, or highly recommend running them only under the guidance of a Support Engineer, or
running them in a test environment with a backup of the instance ready to be running them in a test environment with a backup of the instance ready to be
......
...@@ -36,7 +36,7 @@ The following task will run a [group sync](../auth/ldap/index.md#group-sync-star ...@@ -36,7 +36,7 @@ The following task will run a [group sync](../auth/ldap/index.md#group-sync-star
when you'd like to update all configured group memberships against LDAP without when you'd like to update all configured group memberships against LDAP without
waiting for the next scheduled group sync to be run. waiting for the next scheduled group sync to be run.
NOTE: **NOTE:** NOTE: **Note:**
If you'd like to change the frequency at which a group sync is performed, If you'd like to change the frequency at which a group sync is performed,
[adjust the cron schedule](../auth/ldap/index.md#adjusting-ldap-group-sync-schedule-starter-only) [adjust the cron schedule](../auth/ldap/index.md#adjusting-ldap-group-sync-schedule-starter-only)
instead. instead.
......
...@@ -11,13 +11,13 @@ having an issue with GitLab, it is highly recommended that you check your ...@@ -11,13 +11,13 @@ having an issue with GitLab, it is highly recommended that you check your
[support options](https://about.gitlab.com/support/) first, before attempting to use [support options](https://about.gitlab.com/support/) first, before attempting to use
this information. this information.
CAUTION: **CAUTION:** CAUTION: **Caution:**
Please note that some of these scripts could be damaging if not run correctly, Please note that some of these scripts could be damaging if not run correctly,
or under the right conditions. We highly recommend running them under the or under the right conditions. We highly recommend running them under the
guidance of a Support Engineer, or running them in a test environment with a guidance of a Support Engineer, or running them in a test environment with a
backup of the instance ready to be restored, just in case. backup of the instance ready to be restored, just in case.
CAUTION: **CAUTION:** CAUTION: **Caution:**
Please also note that as GitLab changes, changes to the code are inevitable, Please also note that as GitLab changes, changes to the code are inevitable,
and so some scripts may not work as they once used to. These are not kept and so some scripts may not work as they once used to. These are not kept
up-to-date as these scripts/commands were added as they were found/needed. As up-to-date as these scripts/commands were added as they were found/needed. As
......
...@@ -10,7 +10,7 @@ and it may be useful for users with experience with Linux. If you are currently ...@@ -10,7 +10,7 @@ and it may be useful for users with experience with Linux. If you are currently
having an issue with GitLab, you may want to check your [support options](https://about.gitlab.com/support/) having an issue with GitLab, you may want to check your [support options](https://about.gitlab.com/support/)
first, before attempting to use this information. first, before attempting to use this information.
CAUTION: **CAUTION:** CAUTION: **Caution:**
If you are administering GitLab you are expected to know these commands for your distribution If you are administering GitLab you are expected to know these commands for your distribution
of choice. If you are a GitLab Support Engineer, consider this a cross-reference to of choice. If you are a GitLab Support Engineer, consider this a cross-reference to
translate `yum` -> `apt-get` and the like. translate `yum` -> `apt-get` and the like.
......
...@@ -6,7 +6,7 @@ Thanks to this, we also get access to the amazing tools built right into Rails. ...@@ -6,7 +6,7 @@ Thanks to this, we also get access to the amazing tools built right into Rails.
In this guide, we'll introduce the [Rails console](debug.md#starting-a-rails-console-session) In this guide, we'll introduce the [Rails console](debug.md#starting-a-rails-console-session)
and the basics of interacting with your GitLab instance from the command line. and the basics of interacting with your GitLab instance from the command line.
CAUTION: **CAUTION:** CAUTION: **Caution:**
The Rails console interacts directly with your GitLab instance. In many cases, The Rails console interacts directly with your GitLab instance. In many cases,
there are no handrails to prevent you from permanently modifying, corrupting there are no handrails to prevent you from permanently modifying, corrupting
or destroying production data. If you would like to explore the Rails console or destroying production data. If you would like to explore the Rails console
......
...@@ -351,7 +351,7 @@ Reasons for failure include: ...@@ -351,7 +351,7 @@ Reasons for failure include:
[`environment:name`](../../../ci/environments/index.md#defining-environments). If your job has no [`environment:name`](../../../ci/environments/index.md#defining-environments). If your job has no
`environment:name` set, it will not be passed the Kubernetes credentials. `environment:name` set, it will not be passed the Kubernetes credentials.
NOTE: **NOTE:** NOTE: **Note:**
Project-level clusters upgraded from GitLab 12.0 or older may be configured Project-level clusters upgraded from GitLab 12.0 or older may be configured
in a way that causes this error. Ensure you deselect the in a way that causes this error. Ensure you deselect the
[GitLab-managed cluster](#gitlab-managed-clusters) option if you want to manage [GitLab-managed cluster](#gitlab-managed-clusters) option if you want to manage
......
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