Skip to content

Commit 6f57803

Browse files
authored
Docusaurus v3 (#1884)
* mdxv3 compatibility * chore: update versions of things * chore: fix the caption plugin for v3 * chore: checkin the new caption file * bump from 3.0.0 to 3.5.2 * fix: card imports * chore: fix the root * chore: fix broken links * chore: revert accident to stay up to date * chore: hash updates * chore: regenerate discussions
1 parent 0c410d5 commit 6f57803

File tree

101 files changed

+4482
-3380
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

101 files changed

+4482
-3380
lines changed

Diff for: _docs-sources/foundations/landing-zone/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Gruntwork Landing Zone directly addresses these limitations by extending Control
3333
1. Request new AWS accounts using a simple YAML file, GitHub Actions, or any system that can trigger a GitHub Action (e.g. ServiceNow)
3434
1. Review and customize all new AWS account requests using GitHub Pull Request functionality
3535
1. Define a customized account baseline unique to your organization
36-
1. Enable AWS account baselines to stay up to date automatically using [Patcher](./patcher)
36+
1. Enable AWS account baselines to stay up to date automatically using [Patcher](/patcher)
3737

3838
## Greenfield vs. brownfield
3939

Diff for: _docs-sources/guides/build-it-yourself/achieve-compliance/deployment-walkthrough/create-the-root-account.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The first step is to create your root account. This account will be the parent of all of your other AWS accounts and the central place where you manage billing. You create this initial account manually, via a web browser:
44

5-
- Go to <https://aws.amazon.com>.
5+
- Go to [https://aws.amazon.com](https://aws.amazon.com).
66
- Click Create an AWS Account.
77
- Go through the sign up flow, entering contact and billing details as requested.
88
- You will be asked to enter an email address and password to use as the credentials for the root user of this root account.

Diff for: _docs-sources/guides/build-it-yourself/achieve-compliance/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ pagination_label: Achieve Compliance with the CIS AWS Foundations Benchmark
44
---
55

66
import { CardList } from "/src/components/CardGroup"
7+
import { Card } from "/src/components/Card"
78

89
# Achieve Compliance with the CIS AWS Foundations Benchmark
910

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
# AWS account
22

3-
To use AWS, you must create an AWS account. You do this by signing up at <https://aws.amazon.com>. Once you’ve created
3+
To use AWS, you must create an AWS account. You do this by signing up at [https://aws.amazon.com](https://aws.amazon.com). Once you’ve created
44
an account, it will get a unique, 12-digit
55
_[AWS account ID](https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html)_ (note: the account ID is
66
not in and of itself a secret, so it’s OK to share it with trusted 3rd parties, but you might not want to go so far as
77
to share it publicly on the Internet), and you will be logged into your new AWS account as the root user.
8-
9-
10-
11-

Diff for: _docs-sources/guides/build-it-yourself/landing-zone/core-concepts/iam-users.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ IAM user to your AWS account in a web browser by using the IAM user sign-in URL.
2222

2323
Every AWS account has a unique
2424
_[IAM user sign-in URL](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_how-users-sign-in.html)_. Note
25-
that to login as an IAM user, you do NOT go to <https://console.aws.amazon.com>, as that’s solely the sign-in URL for
25+
that to login as an IAM user, you do NOT go to [https://console.aws.amazon.com](https://console.aws.amazon.com), as that’s solely the sign-in URL for
2626
root users. Instead, IAM users will need to use a sign-in URL of the form
2727
`\https://<ID_OR_ALIAS>.signin.aws.amazon.com/console`, where `ID_OR_ALIAS` is either your AWS account ID (e.g.,
2828
`\https://111122223333.signin.aws.amazon.com/console`) or a
@@ -63,7 +63,3 @@ user permissions, you will need to use IAM policies, which are the topic of the
6363

6464

6565
</div>
66-
67-
68-
69-

Diff for: _docs-sources/guides/build-it-yourself/landing-zone/core-concepts/root-user.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ you can use to login to the AWS console.
2020
#### Logging into the AWS console
2121

2222
After the initial sign up, if you wish to login as the root user, you have to go to
23-
<https://console.aws.amazon.com> and login using the root user’s email address and password.
23+
[https://console.aws.amazon.com](https://console.aws.amazon.com) and login using the root user’s email address and password.
2424

2525
#### Access keys
2626

@@ -53,7 +53,3 @@ more limited permissions, and then you’ll likely never touch the root user acc
5353

5454

5555
</div>
56-
57-
58-
59-

Diff for: _docs-sources/guides/build-it-yourself/landing-zone/deployment-walkthrough/create-the-root-account.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Now let’s create your root AWS account. This account will be the parent of all of your other AWS accounts and
44
the central place where you manage billing. You create this initial account manually, via a web browser:
55

6-
1. Go to <https://aws.amazon.com>.
6+
1. Go to [https://aws.amazon.com](https://aws.amazon.com).
77

88
2. Click Create an AWS Account.
99

Diff for: _docs-sources/guides/build-it-yourself/vpc/production-grade-design/defense-in-depth.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
People make mistakes all the time: forgetting to remove accounts, keeping ports open, including test credentials in
66
production code, etc. Rather than living in an idealized model where you assume people won’t make mistakes, you can
7-
employ a [Defense in Depth](<https://en.wikipedia.org/wiki/Defense_in_depth_(computing)>) strategy of setting up multiple
7+
employ a [Defense in Depth](https://en.wikipedia.org/wiki/Defense_in_depth_(computing)) strategy of setting up multiple
88
layers of protection so that a failure in any single layer doesn’t immediately lead to disaster. You never want to be
99
one typo away from a security incident.
1010

Diff for: _docs-sources/guides/stay-up-to-date/cis/cis-1.5.0/deployment-walkthrough/step-4-verify-the-code-changes.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ The output of the diff will contain messages similar to these:
2929
Terraform will perform the following actions:
3030

3131
# module.rds.module.rds_alarms.aws_cloudwatch_metric_alarm.rds_disk_space_available[0] will be updated in-place
32-
~ resource "aws_cloudwatch_metric_alarm" "rds_disk_space_available" {
32+
~ resource "aws_cloudwatch_metric_alarm" "rds_disk_space_available" \{
3333
...
34-
}
34+
\}
3535

3636
# module.rds.module.rds_alarms.aws_cloudwatch_metric_alarm.rds_high_cpu_utilization[0] will be updated in-place
37-
~ resource "aws_cloudwatch_metric_alarm" "rds_high_cpu_utilization" {
37+
~ resource "aws_cloudwatch_metric_alarm" "rds_high_cpu_utilization" \{
3838
...
39-
}
39+
\}
4040

4141
...
4242

@@ -58,27 +58,27 @@ The output `plan` will contain messages similar to these:
5858

5959
# module.database.aws_db_instance.primary[0] will be destroyed
6060
# (because aws_db_instance.primary is not in configuration)
61-
- resource "aws_db_instance" "primary" {
61+
- resource "aws_db_instance" "primary" \{
6262
...
63-
}
63+
\}
6464

6565
# module.database.aws_db_subnet_group.db[0] will be destroyed
6666
# (because aws_db_subnet_group.db is not in configuration)
67-
- resource "aws_db_subnet_group" "db" {
67+
- resource "aws_db_subnet_group" "db" \{
6868
...
69-
}
69+
\}
7070

7171
...
7272

7373
# module.rds.module.database.aws_db_instance.primary[0] will be created
74-
+ resource "aws_db_instance" "primary" {
74+
+ resource "aws_db_instance" "primary" \{
7575
...
76-
}
76+
\}
7777

7878
# module.rds.module.database.aws_db_subnet_group.db[0] will be created
79-
+ resource "aws_db_subnet_group" "db" {
79+
+ resource "aws_db_subnet_group" "db" \{
8080
...
81-
}
81+
\}
8282

8383
...
8484

Diff for: _docs-sources/guides/stay-up-to-date/terraform/how-to-dry-your-reference-architecture/deployment-walkthrough/refactoring-common-configurations-for-a-component.md

+15-8
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,13 @@ The rest of this guide will cover how to identify and extract the common configu
44
in your Reference Architecture. These steps can be used to refactor any component that is deployed in multiple
55
accounts or environments in your Reference Architecture.
66

7-
- [Step 1: Identify the component](#step-identify-the-component)
8-
- [Step 2: Identify common configurations](#step-identify-common-configurations)
9-
- [Step 3: Extract common configurations](#step-extract-common-configurations)
10-
- [Step 4: Update child configurations](#step-1-update-child-configurations)
7+
- [Refactoring common configurations for a component](#refactoring-common-configurations-for-a-component)
8+
- [Step 1: Identify the component](#step-1-identify-the-component)
9+
- [Step 2: Identify common configurations](#step-2-identify-common-configurations)
10+
- [Using `diff` to identify raw differences](#using-diff-to-identify-raw-differences)
11+
- [Using JSON rendering to identify semantic differences](#using-json-rendering-to-identify-semantic-differences)
12+
- [Step 3: Extract common configurations](#step-3-extract-common-configurations)
13+
- [Step 4: Update child configurations](#step-4-update-child-configurations)
1114

1215
## Step 1: Identify the component
1316

@@ -89,9 +92,13 @@ identified as different across environments.
8992
There are a couple ways to go about this depending on how complex the underlying configuration files are, and how much
9093
customization has been made since the deployment of the Reference Architecture.
9194

92-
- [Using `diff` to identify raw differences](#using-diff-to-identify-raw-differences)
93-
94-
- [Using JSON rendering to identify semantic differences](#using-json-rendering-to-identify-semantic-differences)
95+
- [Refactoring common configurations for a component](#refactoring-common-configurations-for-a-component)
96+
- [Step 1: Identify the component](#step-1-identify-the-component)
97+
- [Step 2: Identify common configurations](#step-2-identify-common-configurations)
98+
- [Using `diff` to identify raw differences](#using-diff-to-identify-raw-differences)
99+
- [Using JSON rendering to identify semantic differences](#using-json-rendering-to-identify-semantic-differences)
100+
- [Step 3: Extract common configurations](#step-3-extract-common-configurations)
101+
- [Step 4: Update child configurations](#step-4-update-child-configurations)
95102

96103
### Using `diff` to identify raw differences
97104

@@ -148,7 +155,7 @@ first diff represents a difference in the `Title` attribute of the movie object
148155
- "Peter Sellers"
149156
+ "Mike Myers"
150157
@ ["Movies",102]
151-
+ {"Title":"Austin Powers","Actors":{"Austin Powers":"Mike Myers"}}
158+
+ \{"Title":"Austin Powers","Actors":\{"Austin Powers":"Mike Myers"\}\}
152159

153160
Like with `diff`, cross off any blocks, attributes, and input keys from the initial list that are different based
154161
on the output, except for `locals`. In the `jd` output, this would be the first element in each `@` entry, or the second

Diff for: _docs-sources/guides/stay-up-to-date/terraform/terraform-12/deployment-walkthrough.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Deployment Walkthrough
22

3-
The following sections outline the steps you need to take in order to migrate from Terraform <= 0.11.X and Terragrunt <=
3+
The following sections outline the steps you need to take in order to migrate from Terraform &lt;= 0.11.X and Terragrunt &lt;=
44
v0.18.x to Terraform 0.12.x and newer and Terragrunt 0.19.x and newer:
55

66
1. [Upgrade modules for compatibility with Terraform 0.12.x](#upgrade-modules-for-compatibility-with-terraform-012x)
@@ -139,7 +139,7 @@ it is very easy to "start over", such as a sandbox or dev environment!**
139139
- Duplicated comment blocks. Sometimes, the upgrade tool will duplicate comment blocks in the middle of the code.
140140
This was most common when there is a comment on a resource attribute.
141141
- Reorganized comment blocks. The tool sometimes moves the comment block somewhere you don't expect. This is
142-
especially problematic for comments within blocks (e.g., in the middle of a vars = { … }) block.
142+
especially problematic for comments within blocks (e.g., in the middle of a vars = \{\}) block.
143143
- `bool` no longer converts to `1` and `0` automatically. If you had the pattern of doing `count = bool`, this no
144144
longer works. You have to explicitly add a conditional: `count = bool ? 1 : 0`.
145145
- In tf11 and under, sometimes you had to do `attr = ["${list}"]` when passing in a `list` to an attribute. In tf12,
@@ -202,8 +202,8 @@ instead of the equivalent one for Terraform.
202202
#### <a id="using-mise-to-manage-multiple-terragrunt-versions"></a>Using mise to manage multiple terragrunt versions
203203

204204
As with Homebrew, you can also use `mise` to manage multiple `terragrunt` versions, using the same method described above in
205-
[Using mise to manage multiple terraform versions](#using-mise-to-manage-multiple-terraform-versions). To use
206-
the method for Terragrunt, replace the references for `terraform` with `terragrunt`.
205+
[Using mise to manage multiple terraform versions](#using-mise-to-manage-multiple-terraform-versions). To use
206+
the method for Terragrunt, replace the references for `terraform` with `terragrunt`.
207207

208208
For example, to install and use `terragrunt` version `0.18.7`, you would run:
209209
```

0 commit comments

Comments
 (0)