Merge branch 'docs-aqualls-spellcheck-forever' into 'master'

Correct more spelling issues

See merge request gitlab-org/gitlab!53394

doc/.vale/gitlab/spelling-exceptions.txt

+accessor
+accessors
 Akismet
 Alertmanager
 Algolia
@@ -75,6 +77,7 @@ burndown
 burnup
 burstable
 cacheable
+Caddy
 callstack
 callstacks
 Camo
@@ -291,6 +294,7 @@ Leiningen
 libFuzzer
 Libravatar
 liveness
+Lodash
 Lograge
 logrotate
 Logrus
@@ -742,6 +746,7 @@ Worldline
 Xcode
 Xeon
 YouTrack
+Yubico
 Zeitwerk
 Zendesk
 zsh

doc/development/testing_guide/end_to_end/rspec_metadata_tests.md

@@ -41,5 +41,5 @@ This is a partial list of the [RSpec metadata](https://relishapp.com/rspec/rspec
 | `:skip_signup_disabled` | The test uses UI to sign up a new user and is skipped in any environment that does not allow new user registration via the UI. |
 | `:smoke`          | The test belongs to the test suite which verifies basic functionality of a GitLab instance.|
 | `:smtp`           | The test requires a GitLab instance to be configured to use an SMTP server. Tests SMTP notification email delivery from GitLab by using MailHog. |
-| `:testcase`       | The link to the test case issue in the [Quality Testcases project](https://gitlab.com/gitlab-org/quality/testcases/). |
+| `:testcase`       | The link to the test case issue in the [Quality Test Cases project](https://gitlab.com/gitlab-org/quality/testcases/). |
 | `:transient`      | The test tests transient bugs. It is excluded by default. |

doc/development/testing_guide/end_to_end/running_tests_that_require_special_setup.md

@@ -78,7 +78,7 @@ CONTAINER ID   ...     PORTS                                    NAMES
 d15d3386a0a8   ...     22/tcp, 443/tcp, 0.0.0.0:32772->80/tcp   gitlab-gitaly-ha
 ```
 
-That shows that the GitLab instance running in the `gitlab-gitaly-ha` container can be reached via `http://localhost:32772`. However, Git operations like cloning and pushing are performed against the URL revealed via the UI as the clone URL. It uses the hostname configured for the GitLab instance, which in this case matches the Docker container name and network, `gitlab-gitaly-ha.test`. Before you can run the tests you need to configure your computer to access the container via that address. One option is to [use caddyserver as described for running tests against GDK](https://gitlab.com/gitlab-org/gitlab-qa/-/blob/master/docs/run_qa_against_gdk.md#workarounds).
+That shows that the GitLab instance running in the `gitlab-gitaly-ha` container can be reached via `http://localhost:32772`. However, Git operations like cloning and pushing are performed against the URL revealed via the UI as the clone URL. It uses the hostname configured for the GitLab instance, which in this case matches the Docker container name and network, `gitlab-gitaly-ha.test`. Before you can run the tests you need to configure your computer to access the container via that address. One option is to [use Caddy server as described for running tests against GDK](https://gitlab.com/gitlab-org/gitlab-qa/-/blob/master/docs/run_qa_against_gdk.md#workarounds).
 
 Another option is to use NGINX.
 

doc/development/testing_guide/frontend_testing.md

@@ -258,7 +258,7 @@ it('exists', () => {
 ### Naming unit tests
 
 When writing describe test blocks to test specific functions/methods,
-please use the method name as the describe block name.
+use the method name as the describe block name.
 
 **Bad**:
 
@@ -439,7 +439,7 @@ it('waits for an Ajax call', done => {
 });
 ```
 
-If you are not able to register handlers to the `Promise`, for example because it is executed in a synchronous Vue life cycle hook, please take a look at the [waitFor](#wait-until-axios-requests-finish) helpers or you can flush all pending `Promise`s:
+If you are not able to register handlers to the `Promise`, for example because it is executed in a synchronous Vue life cycle hook, take a look at the [waitFor](#wait-until-axios-requests-finish) helpers or you can flush all pending `Promise`s:
 
 **in Jest:**
 
@@ -702,10 +702,10 @@ unit testing by mocking out modules which cannot be easily consumed in our test
 Jest supports [manual module mocks](https://jestjs.io/docs/en/manual-mocks) by placing a mock in a `__mocks__/` directory next to the source module
 (e.g. `app/assets/javascripts/ide/__mocks__`). **Don't do this.** We want to keep all of our test-related code in one place (the `spec/` folder).
 
-If a manual mock is needed for a `node_modules` package, please use the `spec/frontend/__mocks__` folder. Here's an example of
+If a manual mock is needed for a `node_modules` package, use the `spec/frontend/__mocks__` folder. Here's an example of
 a [Jest mock for the package `monaco-editor`](https://gitlab.com/gitlab-org/gitlab/blob/b7f914cddec9fc5971238cdf12766e79fa1629d7/spec/frontend/__mocks__/monaco-editor/index.js#L1).
 
-If a manual mock is needed for a CE module, please place it in `spec/frontend/mocks/ce`.
+If a manual mock is needed for a CE module, place it in `spec/frontend/mocks/ce`.
 
 - Files in `spec/frontend/mocks/ce` mocks the corresponding CE module from `app/assets/javascripts`, mirroring the source module's path.
   - Example: `spec/frontend/mocks/ce/lib/utils/axios_utils` mocks the module `~/lib/utils/axios_utils`.
@@ -728,11 +728,11 @@ If a manual mock is needed for a CE module, please place it in `spec/frontend/mo
 Global mocks introduce magic and technically can reduce test coverage. When mocking is deemed profitable:
 
 - Keep the mock short and focused.
-- Please leave a top-level comment in the mock on why it is necessary.
+- Leave a top-level comment in the mock on why it is necessary.
 
 ### Additional mocking techniques
 
-Please consult the [official Jest docs](https://jestjs.io/docs/en/jest-object#mock-modules) for a full overview of the available mocking features.
+Consult the [official Jest docs](https://jestjs.io/docs/en/jest-object#mock-modules) for a full overview of the available mocking features.
 
 ## Running Frontend Tests
 
@@ -865,7 +865,7 @@ end
 This will create a new fixture located at
 `tmp/tests/frontend/fixtures-ee/graphql/releases/queries/all_releases.query.graphql.json`.
 
-Note that you will need to provide the paths to all fragments used by the query.
+You will need to provide the paths to all fragments used by the query.
 `get_graphql_query_as_string` reads all of the provided file paths and returns
 the result as a single, concatenated string.
 
@@ -929,7 +929,8 @@ it.each([
 );
 ```
 
-**Note**: only use template literal block if pretty print is **not** needed for spec output. For example, empty strings, nested objects etc.
+NOTE:
+Only use template literal block if pretty print is not needed for spec output. For example, empty strings, nested objects etc.
 
 For example, when testing the difference between an empty search string and a non-empty search string, the use of the array block syntax with the pretty print option would be preferred. That way the differences between an empty string e.g. `''` and a non-empty string e.g. `'search string'` would be visible in the spec output. Whereas with a template literal block, the empty string would be shown as a space, which could lead to a confusing developer experience
 
@@ -1038,7 +1039,8 @@ import Subject from '~/feature/the_subject.vue';
 import _Thing from '~/feature/path/to/thing.vue';
 ```
 
-**PLEASE NOTE:** Do not simply disregard test timeouts. This could be a sign that there's
+NOTE:
+Do not disregard test timeouts. This could be a sign that there's
 actually a production problem. Use this opportunity to analyze the production webpack bundles and
 chunks and confirm that there is not a production issue with the async imports.
 
@@ -1063,7 +1065,7 @@ See also [Notes on testing Vue components](../fe_guide/vue.md#testing-vue-compon
 ## Test helpers
 
 Test helpers can be found in [`spec/frontend/__helpers__`](https://gitlab.com/gitlab-org/gitlab/blob/master/spec/frontend/__helpers__).
-If you introduce new helpers, please place them in that directory.  
+If you introduce new helpers, place them in that directory.
 
 ### Vuex Helper: `testAction`
 

doc/development/testing_guide/index.md

@@ -9,9 +9,9 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 This document describes various guidelines and best practices for automated
 testing of the GitLab project.
 
-It is meant to be an _extension_ of the [thoughtbot testing
+It is meant to be an _extension_ of the [Thoughtbot testing
 style guide](https://github.com/thoughtbot/guides/tree/master/testing-rspec). If
-this guide defines a rule that contradicts the thoughtbot guide, this guide
+this guide defines a rule that contradicts the Thoughtbot guide, this guide
 takes precedence. Some guidelines may be repeated verbatim to stress their
 importance.
 

doc/development/testing_guide/testing_migrations_guide.md

@@ -32,7 +32,7 @@ migrate the database **down** to the previous migration version.
 
 With this approach you can test a migration against a database schema.
 
-An `after` hook migrates the database **up** and reinstitutes the latest
+An `after` hook migrates the database **up** and restores the latest
 schema version, so that the process does not affect subsequent specs and
 ensures proper isolation.
 

doc/development/windows.md

@@ -63,7 +63,7 @@ Build a Google Cloud image with the above shared runners repository by doing the
 
 ## How to use a Windows image in GCP
 
-1. In a web browser, go to <https://console.cloud.google.com/compute/images>.
+1. In a web browser, go to the [Google Cloud Platform console](https://console.cloud.google.com/compute/images).
 1. Filter images by the name you used when creating image, `windows` is likely all you need to filter by.
 1. Click the image's name.
 1. Click the **CREATE INSTANCE** link.
@@ -81,7 +81,7 @@ Build a Google Cloud image with the above shared runners repository by doing the
 1. Click **Continue** to accept the certificate.
 1. Enter the password and click **Next**.
 
-You should now be remoted into a Windows machine with a command prompt.
+You should now be connected into a Windows machine with a command prompt.
 
 ### Optional: Use GCP VM Instance as a runner
 

doc/integration/security_partners/index.md

@@ -10,4 +10,8 @@ type: index
 You can integrate GitLab with its security partners. This page has information on how do this with
 each security partner:
 
+<!-- vale gitlab.Spelling = NO -->
+
 - [Anchore](https://docs.anchore.com/current/docs/using/integration/ci_cd/gitlab/)
+
+<!-- vale gitlab.Spelling = YES -->

doc/operations/metrics/dashboards/yaml.md

@@ -133,7 +133,7 @@ metrics:
     unit: 'count'
 ```
 
-This works by lowercasing the value of `label` and, if there are more words separated by spaces, replacing those spaces with an underscore (`_`). The transformed value is then checked against the labels of the time series returned by the Prometheus query. If a time series label is found that is equal to the transformed value, then the label value renders in the legend like this:
+This works by converting the value of `label` to lower-case and, if there are more words separated by spaces, replacing those spaces with an underscore (`_`). The transformed value is then checked against the labels of the time series returned by the Prometheus query. If a time series label is found that is equal to the transformed value, then the label value renders in the legend like this:
 
 ![legend with label shorthand variable](img/prometheus_dashboard_label_variable_shorthand.png)
 

doc/raketasks/backup_restore.md

@@ -240,7 +240,7 @@ The resulting file is named `dump_gitlab_backup.tar`. This is useful for
 systems that make use of rsync and incremental backups, and results in
 considerably faster transfer speeds.
 
-#### Rsyncable
+#### Confirm archive can be transferred
 
 To ensure the generated archive is transferable by rsync, you can set the `GZIP_RSYNCABLE=yes`
 option. This sets the `--rsyncable` option to `gzip`, which is useful only in
@@ -1204,9 +1204,9 @@ and the jobs begin running again.
 
 Use the information in the following sections at your own risk.
 
-#### Check for undecryptable values
+#### Verify that all values can be decrypted
 
-You can determine if you have undecryptable values in the database by using the
+You can determine if your database contains values that can't be decrypted by using the
 [Secrets Doctor Rake task](../administration/raketasks/doctor.md).
 
 #### Take a backup

doc/security/password_storage.md

@@ -11,6 +11,6 @@ GitLab stores user passwords in a hashed format, to prevent passwords from being
 
 GitLab uses the [Devise](https://github.com/heartcombo/devise) authentication library, which handles the hashing of user passwords. Password hashes are created with the following attributes:
 
-- **Hashing**: the [bcrypt](https://en.wikipedia.org/wiki/Bcrypt) hashing function is used to generate the hash of the provided password. This is a strong, industry-standard cryptographic hashing function.
+- **Hashing**: the [`bcrypt`](https://en.wikipedia.org/wiki/Bcrypt) hashing function is used to generate the hash of the provided password. This is a strong, industry-standard cryptographic hashing function.
 - **Stretching**: Password hashes are [stretched](https://en.wikipedia.org/wiki/Key_stretching) to harden against brute-force attacks. GitLab uses a stretching factor of 10 by default.
 - **Salting**: A [cryptographic salt](https://en.wikipedia.org/wiki/Salt_(cryptography)) is added to each password to harden against pre-computed hash and dictionary attacks. Each salt is randomly generated for each password, so that no two passwords share a salt, to further increase security.

doc/ssh/README.md

@@ -201,7 +201,7 @@ Now you can copy the SSH key you created to your GitLab account. To do so, follo
    pbcopy < ~/.ssh/id_ed25519.pub
    ```
 
-   **Linux (requires the xclip package):**
+   **Linux (requires the `xclip` package):**
 
    ```shell
    xclip -sel clip < ~/.ssh/id_ed25519.pub

doc/topics/authentication/index.md

@@ -48,6 +48,10 @@ This page gathers all the resources for the topic **Authentication** within GitL
 
 ## Third-party resources
 
+<!-- vale gitlab.Spelling = NO -->
+
 - [Kanboard Plugin GitLab Authentication](https://github.com/kanboard/plugin-gitlab-auth)
 - [Jenkins GitLab OAuth Plugin](https://wiki.jenkins.io/display/JENKINS/GitLab+OAuth+Plugin)
 - [OKD - Configuring Authentication and User Agent](https://docs.okd.io/3.11/install_config/configuring_authentication.html#GitLab)
+
+<!-- vale gitlab.Spelling = YES -->
\ No newline at end of file