docs: fix typos/grammar, add typos + Vale prose-lint CI (#6252)

Copilot · nitrocode · Daan Vinken · commit e992038ed66a · 2026-03-16T13:03:31.000+01:00
Co-authored-by: copilot-swe-agent[bot] &lt;198982749+Copilot@users.noreply.github.com&gt;
Co-authored-by: nitrocode &lt;7775707+nitrocode@users.noreply.github.com&gt;
Signed-off-by: Daan Vinken &lt;dvinken@tesla.com&gt;
diff --git a/.github/styles/Atlantis/ProductTerms.yml b/.github/styles/Atlantis/ProductTerms.yml
@@ -0,0 +1,7 @@
+extends: substitution
+message: "Use '%s' instead of '%s'."
+level: error
+ignorecase: false
+swap:
+  'Github': 'GitHub'
+  'Gitlab': 'GitLab'
diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml
@@ -45,6 +45,9 @@ jobs:
               - 'package-lock.json'
               - 'package.json'
               - '.github/workflows/website.yml'
+              - '.vale.ini'
+              - '_typos.toml'
+              - '.github/styles/**'
 
   # Check that the website builds and there's no missing links.
   website-check:
@@ -60,6 +63,23 @@ jobs:
 
       - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
 
+      - name: Spell check
+        uses: crate-ci/typos@57b11c6b7e54c402ccd9cda953f1072ec4f78e33 # v1.43.5
+        with:
+          files: ./runatlantis.io/docs
+
+      - name: Vale prose linting
+        run: |
+          VALE_VERSION="3.9.4"
+          VALE_TARBALL="vale_${VALE_VERSION}_Linux_64-bit.tar.gz"
+          curl -sLO "https://github.com/errata-ai/vale/releases/download/v${VALE_VERSION}/${VALE_TARBALL}"
+          echo "551f7ef5cabd53affb7b2c8bdbd4cfb6216270d53c4d6e571a567c5b5df0921d  ${VALE_TARBALL}" | sha256sum --check
+          tar xz -C /tmp vale -f "${VALE_TARBALL}"
+          rm "${VALE_TARBALL}"
+          # api-endpoints.md intentionally uses "Github"/"Gitlab" as literal API
+          # string values matching the Go source code constants; exclude it here.
+          /tmp/vale --glob='!*api-endpoints.md' runatlantis.io/docs/
+
       - name: markdown-lint
         uses: DavidAnson/markdownlint-cli2-action@05f32210e84442804257b2a6f20b273450ec8265 # v19
         with:
diff --git a/.vale.ini b/.vale.ini
@@ -0,0 +1,8 @@
+StylesPath = .github/styles
+MinAlertLevel = error
+
+# api-endpoints.md intentionally uses the API string literals "Github" and
+# "Gitlab" (which match the Go source code constants). When running Vale
+# locally, exclude it with: vale --glob='!*api-endpoints.md' runatlantis.io/docs/
+[*.md]
+BasedOnStyles = Atlantis
diff --git a/_typos.toml b/_typos.toml
@@ -0,0 +1,7 @@
+[default.extend-words]
+# HashiCorp is a proper company name; the "Hashi" prefix is intentional
+hashi = "hashi"
+# "ue" is used as a workspace-name prefix in documentation examples (short for us-east)
+ue = "ue"
+# ACI = Azure Container Instances
+aci = "aci"
diff --git a/runatlantis.io/docs/command-requirements.md b/runatlantis.io/docs/command-requirements.md
@@ -23,7 +23,7 @@ by at least one person other than the author.
 
 #### Usage
 
-The `approved` requirement by:
+Set the `approved` requirement by:
 
 1. Creating a `repos.yaml` file with the `apply_requirements` key:
 
@@ -239,7 +239,7 @@ having that apply requirement set.
 
 If you only want some projects/repos to have apply requirements, then you must
 
-1. Specifying which repos have which requirements via the `repos.yaml` file.
+1. Specify which repos have which requirements via the `repos.yaml` file.
 
    ```yaml
    repos:
diff --git a/runatlantis.io/docs/custom-workflows.md b/runatlantis.io/docs/custom-workflows.md
@@ -748,7 +748,7 @@ Full:
 | multienv.command   | string                | none    | yes      | Name of the custom script to run                                                    |
 | multienv.shell     | string                | "sh"    | no       | Name of the shell to use for command execution                                      |
 | multienv.shellArgs | string or []string    | "-c"    | no       | Command line arguments to be passed to the shell. Cannot be set without `shell`     |
-| multienv.output    | string                | "show"  | no       | Setting output to "hide" will suppress the message obout added environment variables |
+| multienv.output    | string                | "show"  | no       | Setting output to "hide" will suppress the message about added environment variables |
 
 The output of the command execution must have the following format:
 `EnvVar1Name=value1,EnvVar2Name=value2,EnvVar3Name=value3`
diff --git a/runatlantis.io/docs/how-atlantis-works.md b/runatlantis.io/docs/how-atlantis-works.md
@@ -1,6 +1,6 @@
 # How Atlantis Works
 
-This section of docs talks about how Atlantis at deeper level.
+This section of docs talks about how Atlantis works at a deeper level.
 
 * [Locking](locking.md)
 * [Autoplanning](autoplanning.md)
diff --git a/runatlantis.io/docs/repo-level-atlantis-yaml.md b/runatlantis.io/docs/repo-level-atlantis-yaml.md
@@ -309,7 +309,7 @@ projects:
 
 :::warning
 `plan_requirements`, `apply_requirements` and `import_requirements` are restricted keys so this repo will need to be configured
-to be allowed to set this key. See [Server-Side Repo Config Use Cases](server-side-repo-config.md#repos-can-set-their-own-apply-an-applicable-subcommand).
+to be allowed to set this key. See [Server-Side Repo Config Use Cases](server-side-repo-config.md#repos-can-set-their-own-apply-requirements).
 :::
 
 ### Order of planning/applying
@@ -471,8 +471,8 @@ workflow: myworkflow
 | name                                    | string                  | none            | maybe    | Required if there is more than one project with the same `dir` and `workspace`. This project name can be used with the `-p` flag.                                                                                                       |
 | branch                                  | string                  | none            | no       | Regex matching projects by the base branch of pull request (the branch the pull request is getting merged into). Only projects that match the PR's branch will be considered. By default, all branches are matched.                     |
 | dir                                     | string                  | none            | **yes**  | The directory of this project relative to the repo root. For example if the project was under `./project1` then use `project1`. Use `.` to indicate the repo root.                                                                      |
-| workspace                               | string                  | `"default"`     | no       | The [Terraform workspace](https://developer.hashicorp.com/terraform/language/state/workspaces) for this project. Atlantis will switch to this workplace when planning/applying and will create it if it doesn't exist.                  |
-| execution_order_group                   | int                     | `0`             | no       | Index of execution order group. Projects will be sort by this field before planning/applying.                                                                                                                                           |
+| workspace                               | string                  | `"default"`     | no       | The [Terraform workspace](https://developer.hashicorp.com/terraform/language/state/workspaces) for this project. Atlantis will switch to this workspace when planning/applying and will create it if it doesn't exist.                  |
+| execution_order_group                   | int                     | `0`             | no       | Index of execution order group. Projects will be sorted by this field before planning/applying.                                                                                                                                         |
 | delete_source_branch_on_merge           | bool                    | `false`         | no       | Automatically deletes the source branch on merge.                                                                                                                                                                                       |
 | repo_locking                            | bool                    | `true`          | no       | (deprecated) Get a repository lock in this project when plan.                                                                                                                                                                           |
 | repo_locks                              | [RepoLocks](#repolocks) | `mode: on_plan` | no       | Get a repository lock in this project on plan or apply. See [RepoLocks](#repolocks) for more details.                                                                                                                                   |
diff --git a/runatlantis.io/docs/security.md b/runatlantis.io/docs/security.md
@@ -76,7 +76,7 @@ Even with the `--repo-allowlist` flag set, without a webhook secret, attackers c
 Webhook secrets ensure that the webhook requests are actually coming from your VCS provider (GitHub or GitLab).
 
 :::tip Tip
-If you are using Azure DevOps, instead of webhook secrets add a [basic username and password](#azure devops basic authentication)
+If you are using Azure DevOps, instead of webhook secrets add a [basic username and password](#azure-devops-basic-authentication)
 :::
 
 ### Azure DevOps Basic Authentication
@@ -91,7 +91,7 @@ flags.
 
 ### Enable Authentication on Atlantis Web Server
 
-It is very recommended to enable authentication in the web service. Enable BasicAuth using the `--web-basic-auth=true` and setup a username and a password using `--web-username=yourUsername` and `--web-password=yourPassword` flags.
+It is highly recommended to enable authentication in the web service. Enable BasicAuth using the `--web-basic-auth=true` and set up a username and a password using `--web-username=yourUsername` and `--web-password=yourPassword` flags.
 
 You can also pass these as environment variables `ATLANTIS_WEB_BASIC_AUTH=true` `ATLANTIS_WEB_USERNAME=yourUsername` and `ATLANTIS_WEB_PASSWORD=yourPassword`.
 
diff --git a/runatlantis.io/docs/server-configuration.md b/runatlantis.io/docs/server-configuration.md
@@ -543,8 +543,8 @@ Defaults to "" (empty string).
 ::: warning NOTE
 Each VCS provider supports a different list of emojis:
 
-- [Github](https://docs.github.com/en/rest/reactions/reactions?apiVersion=2022-11-28#about-reactions)
-- [Gitlab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/fixtures/emojis/digests.json)
+- [GitHub](https://docs.github.com/en/rest/reactions/reactions?apiVersion=2022-11-28#about-reactions)
+- [GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/fixtures/emojis/digests.json)
 - [Azure DevOps](https://learn.microsoft.com/en-us/azure/devops/project/wiki/markdown-guidance?view=azure-devops#emoji)
 
    :::
@@ -744,7 +744,7 @@ In versions v0.35.0 and later, the GitHub team name can only be a slug because i
 
 In versions between v0.21.0 and v0.34.0, the GitHub team name can be a name or a slug.
 
-In versions v0.20.1 and below, the Github team name required the case sensitive team name.
+In versions v0.20.1 and below, the GitHub team name required the case sensitive team name.
 
 Comma-separated list of GitHub teams and permission pairs.
 
@@ -889,7 +889,7 @@ atlantis server --gitlab-hostname="my.gitlab.enterprise.com"
 ATLANTIS_GITLAB_HOSTNAME="my.gitlab.enterprise.com"
 ```
 
-Hostname of your GitLab Enterprise installation. If using [Gitlab.com](https://gitlab.com),
+Hostname of your GitLab Enterprise installation. If using [GitLab.com](https://gitlab.com),
 don't set. Defaults to `gitlab.com`.
 
 ### `--gitlab-status-retry-enabled`
@@ -1484,7 +1484,7 @@ This flag is useful when having multiple projects that need to run a plan and ap
 - [plugin_cache_dir concurrently discussion](https://github.com/hashicorp/terraform/issues/31964)
 - [PR to improve the situation](https://github.com/hashicorp/terraform/pull/33479)
 
-The effect of the race condition is more evident when using parallel configuration to run plan and apply, by disabling the use of plugin cache will impact in the performance when starting a new plan or apply, but in large atlantis deployments with multiple projects and shared modules the use of `--parallel_plan` and `--parallel_apply` is mandatory for an efficient management of the PRs.
+The effect of the race condition is more evident when using parallel configuration to run plan and apply. Disabling the use of plugin cache will impact the performance when starting a new plan or apply, but in large Atlantis deployments with multiple projects and shared modules the use of `--parallel_plan` and `--parallel_apply` is mandatory for an efficient management of the PRs.
 
 ### `--var-file-allowlist` <Badge text="v0.19.5" type="info"/>
 
diff --git a/runatlantis.io/docs/server-side-repo-config.md b/runatlantis.io/docs/server-side-repo-config.md
@@ -185,7 +185,7 @@ repos:
 
 See [Command Requirements](command-requirements.md) for more details.
 
-### Repos Can Set Their Own Apply an applicable subcommand
+### Repos Can Set Their Own Apply Requirements
 
 If you want all (or specific) repos to be able to override the default apply requirements, use
 the `allowed_overrides` key.
diff --git a/runatlantis.io/docs/streaming-logs.md b/runatlantis.io/docs/streaming-logs.md
@@ -6,14 +6,14 @@ Atlantis supports streaming terraform logs in real time by default. Currently, o
 * atlantis apply
 
 ::: warning
-As of now, not all custom workflow outputs and other terraform commands are not supported.  Support for terragrunt has been added, see examples in [Custom Workflows](./custom-workflows.md#terragrunt).
+Not all custom workflow outputs and other terraform commands are supported. Support for terragrunt has been added, see examples in [Custom Workflows](./custom-workflows.md#terragrunt).
 :::
 
 In order to view real-time terraform logs, a user can navigate through the *details* section of a given project's plan or apply status check.
 
 ![Plan Command](./images/plan.png)
 
-This will link to the atlantis UI which provides real-time logging in addition to native terraform syntax highlighting.
+This will link to the Atlantis UI which provides real-time logging in addition to native terraform syntax highlighting.
 
 ![Plan Output](./images/plan_output.png)
 
diff --git a/runatlantis.io/docs/using-atlantis.md b/runatlantis.io/docs/using-atlantis.md
@@ -4,7 +4,7 @@ Atlantis triggers commands via pull request comments.
 ![Help Command](./images/pr-comment-help.png)
 
 ::: tip
-You can use following executable names.
+You can use the following executable names.
 
 * `atlantis help`
   * `atlantis` is executable name. You can configure by [Executable Name](server-configuration.md#executable-name).
@@ -80,7 +80,7 @@ atlantis plan -w staging
 * `--verbose` Append Atlantis log to comment.
 
 ::: warning NOTE
-A `atlantis plan` (without flags), like autoplans, discards all plans previously created with `atlantis plan` `-p`/`-d`/`-w`
+An `atlantis plan` (without flags), like autoplans, discards all plans previously created with `atlantis plan` `-p`/`-d`/`-w`
 :::
 
 ### Additional Terraform flags
@@ -136,7 +136,7 @@ atlantis plan -d dir -- -destroy
 ```
 
 ::: warning NOTE
-The `-destroy` flag generates a destroy plan, If this plan is applied it can result in data loss or service disruptions. Ensure that you have thoroughly reviewed your Terraform configuration and intend to remove the specified resources before using this flag.
+The `-destroy` flag generates a destroy plan. If this plan is applied it can result in data loss or service disruptions. Ensure that you have thoroughly reviewed your Terraform configuration and intend to remove the specified resources before using this flag.
 :::
 
 ---
@@ -256,7 +256,7 @@ atlantis import -w staging ADDRESS ID
 
 ::: tip
 
-* If import for_each resources, it requires a single quoted address.
+* When importing `for_each` resources, a single quoted address is required.
   * ex. `atlantis import 'aws_instance.example["foo"]' i-1234567890abcdef0`
 :::
 
@@ -288,7 +288,7 @@ atlantis state [options] rm ADDRESS... -- [terraform state rm flags]
 ### Explanation
 
 Runs `terraform state rm` that matches the directory/project/workspace.
-This command discards the terraform plan result. After run state rm and before an apply, another `atlantis plan` must be run again.
+This command discards the terraform plan result. After running `state rm` and before an apply, another `atlantis plan` must be run again.
 
 To allow the `state` command requires [--allow-commands](server-configuration.md#allow-commands) configuration.
 
@@ -310,7 +310,7 @@ atlantis state -w staging rm ADDRESS
 
 ::: tip
 
-* If run state rm to for_each resources, it requires a single quoted address.
+* When running `state rm` on `for_each` resources, a single quoted address is required.
   * ex. `atlantis state rm 'aws_instance.example["foo"]'`
 :::
 
