Fix: README Formatting for Docusarus (#1084)

milldr · web-flow · commit d12201d0affe · 2024-07-25T16:09:04.000-04:00
diff --git a/modules/account/README.md b/modules/account/README.md
@@ -4,7 +4,9 @@ This component is responsible for provisioning the full account hierarchy along
 includes the ability to associate Service Control Policies (SCPs) to the Organization, each Organizational Unit and
 account.
 
-:::info Part of a
+:::info
+
+Part of a
 [cold start](https://docs.cloudposse.com/reference-architecture/how-to-guides/implementation/enterprise/implement-aws-cold-start)
 so it has to be initially run with `SuperAdmin` role.
 
@@ -176,11 +178,13 @@ SuperAdmin) credentials you have saved in 1Password.
 
 #### Request an increase in the maximum number of accounts allowed
 
-:::caution Make sure your support plan for the _root_ account was upgraded to the "Business" level (or Higher). This is
-necessary to expedite the quota increase requests, which could take several days on a basic support plan. Without it,
-AWS support will claim that since we’re not currently utilizing any of the resources, so they do not want to approve the
-requests. AWS support is not aware of your other organization. If AWS still gives you problems, please escalate to your
-AWS TAM. See [AWS](https://docs.cloudposse.com/reference-architecture/reference/aws).
+:::caution
+
+Make sure your support plan for the _root_ account was upgraded to the "Business" level (or Higher). This is necessary
+to expedite the quota increase requests, which could take several days on a basic support plan. Without it, AWS support
+will claim that since we’re not currently utilizing any of the resources, so they do not want to approve the requests.
+AWS support is not aware of your other organization. If AWS still gives you problems, please escalate to your AWS TAM.
+See [AWS](https://docs.cloudposse.com/reference-architecture/reference/aws).
 
 :::
 
@@ -314,15 +318,19 @@ atmos terraform import account --stack core-gbl-root 'aws_organizations_organiza
 AWS accounts and organizational units are generated dynamically by the `terraform/account` component using the
 configuration in the `gbl-root` stack.
 
-:::info _**Special note:**_ \*\*\*\* In the rare case where you will need to be enabling non-default AWS Regions,
-temporarily comment out the `DenyRootAccountAccess` service control policy setting in `gbl-root.yaml`. You will restore
-it later, after enabling the optional Regions. See related:
+:::info _**Special note:**_
+
+In the rare case where you will need to be enabling non-default AWS Regions, temporarily comment out the
+`DenyRootAccountAccess` service control policy setting in `gbl-root.yaml`. You will restore it later, after enabling the
+optional Regions. See related:
 [Decide on Opting Into Non-default Regions](https://docs.cloudposse.com/reference-architecture/design-decisions/cold-start/decide-on-opting-into-non-default-regions)
 
 :::
 
-:::caution **You must wait until your quota increase request has been granted.** If you try to create the accounts
-before the quota increase is granted, you can expect to see failures like `ACCOUNT_NUMBER_LIMIT_EXCEEDED`.
+:::caution You must wait until your quota increase request has been granted
+
+If you try to create the accounts before the quota increase is granted, you can expect to see failures like
+`ACCOUNT_NUMBER_LIMIT_EXCEEDED`.
 
 :::
 
diff --git a/modules/datadog-lambda-forwarder/README.md b/modules/datadog-lambda-forwarder/README.md
@@ -85,7 +85,7 @@ components:
 |------|-------------|------|---------|:--------:|
 | <a name="input_additional_tag_map"></a> [additional\_tag\_map](#input\_additional\_tag\_map) | Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br>This is for some rare cases where resources want additional configuration of tags<br>and therefore take a list of maps with tag key, value, and additional configuration. | `map(string)` | `{}` | no |
 | <a name="input_attributes"></a> [attributes](#input\_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br>in the order they appear in the list. New attributes are appended to the<br>end of the list. The elements of the list are joined by the `delimiter`<br>and treated as a single ID element. | `list(string)` | `[]` | no |
-| <a name="input_cloudwatch_forwarder_event_patterns"></a> [cloudwatch\_forwarder\_event\_patterns](#input\_cloudwatch\_forwarder\_event\_patterns) | Map of title => CloudWatch Event patterns to forward to Datadog. Event structure from here: <https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html#CloudWatchEventsPatterns><br>Example:<pre>hcl<br>cloudwatch_forwarder_event_rules = {<br>  "guardduty" = {<br>    source = ["aws.guardduty"]<br>    detail-type = ["GuardDuty Finding"]<br>  }<br>  "ec2-terminated" = {<br>    source = ["aws.ec2"]<br>    detail-type = ["EC2 Instance State-change Notification"]<br>    detail = {<br>      state = ["terminated"]<br>    }<br>  }<br>}</pre> | <pre>map(object({<br>    version     = optional(list(string))<br>    id          = optional(list(string))<br>    detail-type = optional(list(string))<br>    source      = optional(list(string))<br>    account     = optional(list(string))<br>    time        = optional(list(string))<br>    region      = optional(list(string))<br>    resources   = optional(list(string))<br>    detail      = optional(map(list(string)))<br>  }))</pre> | `{}` | no |
+| <a name="input_cloudwatch_forwarder_event_patterns"></a> [cloudwatch\_forwarder\_event\_patterns](#input\_cloudwatch\_forwarder\_event\_patterns) | Map of title to CloudWatch Event patterns to forward to Datadog. Event structure from here: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html#CloudWatchEventsPatterns<br>Example:<pre>hcl<br>cloudwatch_forwarder_event_rules = {<br>  "guardduty" = {<br>    source = ["aws.guardduty"]<br>    detail-type = ["GuardDuty Finding"]<br>  }<br>  "ec2-terminated" = {<br>    source = ["aws.ec2"]<br>    detail-type = ["EC2 Instance State-change Notification"]<br>    detail = {<br>      state = ["terminated"]<br>    }<br>  }<br>}</pre> | <pre>map(object({<br>    version     = optional(list(string))<br>    id          = optional(list(string))<br>    detail-type = optional(list(string))<br>    source      = optional(list(string))<br>    account     = optional(list(string))<br>    time        = optional(list(string))<br>    region      = optional(list(string))<br>    resources   = optional(list(string))<br>    detail      = optional(map(list(string)))<br>  }))</pre> | `{}` | no |
 | <a name="input_cloudwatch_forwarder_log_groups"></a> [cloudwatch\_forwarder\_log\_groups](#input\_cloudwatch\_forwarder\_log\_groups) | Map of CloudWatch Log Groups with a filter pattern that the Lambda forwarder will send logs from. For example: { mysql1 = { name = "/aws/rds/maincluster", filter\_pattern = "" } | `map(map(string))` | `{}` | no |
 | <a name="input_context"></a> [context](#input\_context) | Single object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as `null` to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional\_tag\_map, which are merged. | `any` | <pre>{<br>  "additional_tag_map": {},<br>  "attributes": [],<br>  "delimiter": null,<br>  "descriptor_formats": {},<br>  "enabled": true,<br>  "environment": null,<br>  "id_length_limit": null,<br>  "label_key_case": null,<br>  "label_order": [],<br>  "label_value_case": null,<br>  "labels_as_tags": [<br>    "unset"<br>  ],<br>  "name": null,<br>  "namespace": null,<br>  "regex_replace_chars": null,<br>  "stage": null,<br>  "tags": {},<br>  "tenant": null<br>}</pre> | no |
 | <a name="input_context_tags"></a> [context\_tags](#input\_context\_tags) | List of context tags to add to each monitor | `set(string)` | <pre>[<br>  "namespace",<br>  "tenant",<br>  "environment",<br>  "stage"<br>]</pre> | no |
@@ -154,7 +154,7 @@ components:
 
 ## References
 
-- Datadog's [documentation about provisioning keys](https://docs.datadoghq.com/account_management/api-app-keys
+- Datadog's [documentation about provisioning keys](https://docs.datadoghq.com/account_management/api-app-keys)
 - [cloudposse/terraform-aws-components](https://github.com/cloudposse/terraform-aws-components/tree/main/modules/datadog-lambda-forwarder) -
   Cloud Posse's upstream component
 
diff --git a/modules/datadog-lambda-forwarder/variables.tf b/modules/datadog-lambda-forwarder/variables.tf
@@ -127,7 +127,7 @@ variable "cloudwatch_forwarder_event_patterns" {
     detail      = optional(map(list(string)))
   }))
   description = <<-EOF
-    Map of title => CloudWatch Event patterns to forward to Datadog. Event structure from here: <https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html#CloudWatchEventsPatterns>
+    Map of title to CloudWatch Event patterns to forward to Datadog. Event structure from here: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html#CloudWatchEventsPatterns
     Example:
     ```hcl
     cloudwatch_forwarder_event_rules = {
diff --git a/modules/dns-primary/README.md b/modules/dns-primary/README.md
@@ -93,7 +93,9 @@ components:
                 YourVeryLongStringGoesHere
 ```
 
-:::info Use the [acm](https://docs.cloudposse.com/components/library/aws/acm) component for more advanced certificate
+:::info
+
+Use the [acm](https://docs.cloudposse.com/components/library/aws/acm) component for more advanced certificate
 requirements.
 
 :::
diff --git a/modules/ecr/README.md b/modules/ecr/README.md
@@ -6,8 +6,10 @@ This utilizes
 to assign accounts to various roles. It is also compatible with the
 [GitHub Actions IAM Role mixin](https://github.com/cloudposse/terraform-aws-components/blob/master/mixins/github-actions-iam-role/README-github-action-iam-role.md).
 
-:::caution Older versions of our reference architecture have an`eks-iam` component that needs to be updated to provide
-sufficient IAM roles to allow pods to pull from ECR repos
+:::caution
+
+Older versions of our reference architecture have an`eks-iam` component that needs to be updated to provide sufficient
+IAM roles to allow pods to pull from ECR repos
 
 :::
 
diff --git a/modules/eks/actions-runner-controller/README.md b/modules/eks/actions-runner-controller/README.md
@@ -384,9 +384,11 @@ scale down to zero before finishing all the jobs, leaving some waiting indefinit
 the `max_duration` to a time long enough to cover the full time a job may have to wait between the time it is queued and
 the time it finishes, assuming that the HRA scales up the pool by 1 and runs the job on the new runner.
 
-:::info If there are more jobs queued than there are runners allowed by `maxReplicas`, the timeout timer does not start
-on the capacity reservation until enough reservations ahead of it are removed for it to be considered as representing
-and active job. Although there are some edge cases regarding `max_duration` that seem not to be covered properly (see
+:::info
+
+If there are more jobs queued than there are runners allowed by `maxReplicas`, the timeout timer does not start on the
+capacity reservation until enough reservations ahead of it are removed for it to be considered as representing and
+active job. Although there are some edge cases regarding `max_duration` that seem not to be covered properly (see
 [actions-runner-controller issue #2466](https://github.com/actions/actions-runner-controller/issues/2466)), they only
 merit adding a few extra minutes to the timeout.
 
diff --git a/modules/eks/datadog-agent/README.md b/modules/eks/datadog-agent/README.md
@@ -105,8 +105,11 @@ for `<integration name>.yaml`.
 
 #### Sample Yaml
 
-:::caution The key of a filename must match datadog docs, which is `<INTEGRATION_NAME>.yaml`
+:::caution
+
+The key of a filename must match datadog docs, which is `<INTEGRATION_NAME>.yaml`
 [Datadog Cluster Checks](https://docs.datadoghq.com/agent/cluster_agent/clusterchecks/?tab=helm#configuration-from-static-configuration-files)
+
 :::
 
 Cluster Checks **can** be used for external URL testing (loadbalancer endpoints), whereas annotations **must** be used
diff --git a/modules/eks/github-actions-runner/README.md b/modules/eks/github-actions-runner/README.md
@@ -27,8 +27,10 @@ NodeJS or `dcarbone/install-jq-action` to install `jq`. You can also install pac
 `awalsh128/cache-apt-pkgs-action`, which has the advantage of being able to skip the installation if the package is
 already installed, so you can more efficiently run the same workflow on GitHub hosted as well as self-hosted runners.
 
-:::info There are (as of this writing) open feature requests to add some commonly needed packages to the official Runner
-Sets runner image. You can upvote these requests
+:::info
+
+There are (as of this writing) open feature requests to add some commonly needed packages to the official Runner Sets
+runner image. You can upvote these requests
 [here](https://github.com/actions/actions-runner-controller/discussions/3168) and
 [here](https://github.com/orgs/community/discussions/80868) to help get them implemented.
 
diff --git a/modules/github-runners/README.md b/modules/github-runners/README.md
@@ -2,7 +2,9 @@
 
 This component is responsible for provisioning EC2 instances for GitHub runners.
 
-:::info We also have a similar component based on
+:::info
+
+We also have a similar component based on
 [actions-runner-controller](https://github.com/actions-runner-controller/actions-runner-controller) for Kubernetes.
 
 :::
@@ -177,9 +179,11 @@ permissions “mode” for Self-hosted runners to Read-Only. The instructions fo
 
 ### Creating Registration Token
 
-:::info We highly recommend using a GitHub Application with the github-action-token-rotator module to generate the
-Registration Token. This will ensure that the token is rotated and that the token is stored in SSM Parameter Store
-encrypted with KMS.
+:::info
+
+We highly recommend using a GitHub Application with the github-action-token-rotator module to generate the Registration
+Token. This will ensure that the token is rotated and that the token is stored in SSM Parameter Store encrypted with
+KMS.
 
 :::
 
diff --git a/modules/redshift/README.md b/modules/redshift/README.md
@@ -46,14 +46,14 @@ components:
 | Name | Version |
 |------|---------|
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
-| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.17, <=4.67.0 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.17, <= 4.67.0 |
 | <a name="requirement_random"></a> [random](#requirement\_random) | >= 3.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.17, <=4.67.0 |
+| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.17, <= 4.67.0 |
 | <a name="provider_random"></a> [random](#provider\_random) | >= 3.0 |
 
 ## Modules
diff --git a/modules/redshift/versions.tf b/modules/redshift/versions.tf
@@ -4,7 +4,7 @@ terraform {
   required_providers {
     aws = {
       source  = "hashicorp/aws"
-      version = ">= 4.17, <=4.67.0"
+      version = ">= 4.17, <= 4.67.0"
     }
     random = {
       source  = "hashicorp/random"
