Skip to content

Commit 2df1d24

Browse files
authored
Fix typos in markdown docs (#781)
1 parent df585d6 commit 2df1d24

33 files changed

Lines changed: 43 additions & 43 deletions

docs/best-practices/terraform.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ restricted, you should not use a custom validator to enforce that for two reason
212212
2. If you use a custom validator to enforce that the string is one of those
213213
two values, and then a later version of the resource adds a new option to the
214214
enumeration, such as "HOURLY", the custom validator will prevent the
215-
module from using the new value, even though the module woudl function
215+
module from using the new value, even though the module would function
216216
perfectly were it not for the validator. This adds work and delay to the
217217
adoption of underlying enhancements to the resource, without providing
218218
enough benefit to be worth the extra effort.

docs/community/contribute/component-testing.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ The difference with a regular atmos configuration are:
8787
1. All components deployed on one stack `default-test` in one `us-east-2` region.
8888
2. Use single aws account for all test resources. If component assumes the cross region or cross account interaction, the configuration still deploys it to the same actual aws account.
8989
3. Mock `account-map` component to skip role assuming and always use current AWS credentials provided with environment variables
90-
4. Configure teraform state files storage to local directory at a path provided by test framework with environment variable `COMPONENT_HELPER_STATE_DIR`
90+
4. Configure terraform state files storage to local directory at a path provided by test framework with environment variable `COMPONENT_HELPER_STATE_DIR`
9191
</Steps>
9292

9393
This configuration is common for all components and could be copied from [template repo](https://github.com/cloudposse-terraform-components/template/tree/main/test).
@@ -218,7 +218,7 @@ A test suite run consists of the following phases all of which can be controlled
218218
| Test | Deploy the component |`--only-deploy-dependencies`|
219219
| Teardown | Destroy all dependencies |`--skip-teardown` |
220220

221-
This is possible to enable/disable steps on each phase more precisly
221+
This is possible to enable/disable steps on each phase more precisely
222222

223223
| Phase | Description | Skip flag |
224224
|------------|--------------------------------------------------------|-----------------------------|
@@ -230,7 +230,7 @@ This is possible to enable/disable steps on each phase more precisly
230230
| Teardown | Destroy all dependencies |`--skip-destroy-dependencies`|
231231

232232

233-
Here is the usefull combination of flags.
233+
Here is the useful combination of flags.
234234

235235
| Command | Description |
236236
|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|

docs/community/contribute/contributor-tips.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Here is a standard usage pattern that contributors can adopt to specific changes
3434
1. `mkdir ~/mp_workspace && cd ~/mp_workspace`
3535
1. Initialize microplane:
3636
1. `mp init --all-repos "cloudposse"`
37-
1. Initializing creates an `mp/` folder in your current directoy, finds all of the Cloud Posse public projects, and then creates an `mp/init.json` file describing them.
37+
1. Initializing creates an `mp/` folder in your current directory, finds all of the Cloud Posse public projects, and then creates an `mp/init.json` file describing them.
3838
1. NOTE: microplane supposedly has the ability to search against an organization and narrow the returned repos that end up in `init.json`, but that functionality seems buggy and not working. We do our repo filtering manually in the next step.
3939
1. Manually edit `mp/init.json` to only include the repos which you want to make changes against.
4040
1. Your editor's multi-select and edit capabilities are your friend here! (or maybe some [`jq`](https://stedolan.github.io/jq/) if that's your thing)

docs/community/contribute/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ We're not accepting new features for pre-terraform-0.12 modules.
120120

121121
## Why is my Terraform Pull Request not yet reviewed or merged?
122122

123-
If your Pull Request is to upgrade a Terraform module from HCLv1 to HCLv2, then chances are we haven't approved it because it does not have `terratest` integration tests. As a general policy, we're only upgrading modules to HCLv2 that have `terratest` integration tests. Attemting to maintain stability
123+
If your Pull Request is to upgrade a Terraform module from HCLv1 to HCLv2, then chances are we haven't approved it because it does not have `terratest` integration tests. As a general policy, we're only upgrading modules to HCLv2 that have `terratest` integration tests. Attempting to maintain stability
124124
with hundreds of modules is only possible with integration testing.
125125

126126
:::info

docs/jumpstart/kickoff.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ Cloud Posse has noticed several patterns that lead to successful projects.
179179
<Step>
180180
### <StepNumber/> Cameras On
181181

182-
We recommend that all participants have their cameras on. This helps to build trust and rapport. It also helps to keep everyone engaged and focused. This also lets us gage how everyone is understanding the material. If you are having trouble understanding something, please ask questions.
182+
We recommend that all participants have their cameras on. This helps to build trust and rapport. It also helps to keep everyone engaged and focused. This also lets us gauge how everyone is understanding the material. If you are having trouble understanding something, please ask questions.
183183

184184
</Step>
185185

docs/layers/accounts/tutorials/how-to-create-and-setup-aws-accounts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ readonly profile_order=(
189189
Rebuild the container to update the script or use the `rootfs/usr/local/bin/aws-accounts` directly.
190190

191191
```
192-
# regnerate cicd profiles
192+
# regenerate cicd profiles
193193
aws-accounts gen-cicd > rootfs/etc/aws-config/aws-config-cicd-$TENANT
194194
195195
# regenerate local saml profiles

docs/layers/accounts/tutorials/how-to-delete-aws-accounts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ programmatic way to destroy accounts. The following ClickOps method is required
1818

1919
:::caution
2020

21-
Email accounts associated with AWS accounts are globally unique and cannot be re-used even after the account deletion.
21+
Email accounts associated with AWS accounts are globally unique and cannot be reused even after the account deletion.
2222
If you ever intend to use the email address again with AWS on another account, we strongly recommend that you first
2323
rename the email address on record before proceeding to delete the account.
2424

docs/layers/alerting/opsgenie/opsgenie.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ An important note here is the **Service** mapping from **Datadog** to **OpsGenie
112112

113113
## Incidents
114114

115-
An Incident is an escalated alert with a business impact. All SLOs by definition have business impacts and therefore when violated should be considered an incident. We define anything of severity P1 or P2 as an incident and therefor having business impact. An alert is automatically escalated to an incident by its severity as defined in the monitor.
115+
An Incident is an escalated alert with a business impact. All SLOs by definition have business impacts and therefore when violated should be considered an incident. We define anything of severity P1 or P2 as an incident and therefore having business impact. An alert is automatically escalated to an incident by its severity as defined in the monitor.
116116

117117
## Component: `opsgenie-team`
118118

docs/layers/identity/docs/dynamic-terraform-roles.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -700,7 +700,7 @@ the `devops` team access to it, and perhaps including the CI/CD team(s).
700700

701701
In the `identity` account, the `terraform` role should currently be
702702
controlled by the `aws-teams` configuration. You should have already added
703-
`mangers` the `trusted_teams` list for the `terraform` role via `aws-teams`,
703+
`managers` the `trusted_teams` list for the `terraform` role via `aws-teams`,
704704
but double-check now.
705705

706706
Later, you will deploy the `aws-team-roles` stack to the `identity` account,

docs/layers/network/design-decisions/decide-on-primary-aws-region.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ This is especially true if most of the services in the default region will be co
2929

3030
When operating on AWS, selecting a region other than `us-east-1` is advisable as this is the default region (or used to
3131
be) for most AWS users. It has historically had the most service interruptions presumably because it is one of the most
32-
heavily-used regions and operates at a scale much larger than other AWS regions. Therefor we advise using `us-east-2`
32+
heavily-used regions and operates at a scale much larger than other AWS regions. Therefore we advise using `us-east-2`
3333
over `us-east-1` and the latencies between these regions is very minimal.
3434

3535
### High Availability / Availability Zones

0 commit comments

Comments
 (0)