feat: prettier in READMEs (cloudposse/terraform-aws-components#998)

cloudposse-terraform-components · Mar 11, 2024 · 0b40c4a · 0b40c4a
1 parent 8945b7b
commit 0b40c4a
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 7 deletions.
diff --git a/src/CHANGELOG.md b/src/CHANGELOG.md
@@ -1,7 +1,7 @@
 ## Components PR [Fix components](https://github.com/cloudposse/terraform-aws-components/pull/855)
 
-This is a bug fix and feature enhancement update.
-No actions necessary to upgrade.
+This is a bug fix and feature enhancement update. No actions necessary to upgrade.
 
 ## Fixes
-* Fix bug related to the AWS provider `>= 5.0.0` removed `redshift_cluster.cluster_security_groups`.
+
+- Fix bug related to the AWS provider `>= 5.0.0` removed `redshift_cluster.cluster_security_groups`.
diff --git a/src/README.md b/src/README.md
@@ -1,6 +1,7 @@
 # Component: `redshift`
 
-This component is responsible for provisioning a RedShift instance. It seeds relevant database information (hostnames, username, password, etc.) into AWS SSM Parameter Store.
+This component is responsible for provisioning a RedShift instance. It seeds relevant database information (hostnames,
+username, password, etc.) into AWS SSM Parameter Store.
 
 ## Usage
 
@@ -36,9 +37,9 @@ components:
             protocol: tcp
             cidr_blocks:
               - 10.0.0.0/8
-
 ```
 
+<!-- prettier-ignore-start -->
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
 
@@ -139,10 +140,11 @@ components:
 | <a name="output_redshift_database_ssm_key_prefix"></a> [redshift\_database\_ssm\_key\_prefix](#output\_redshift\_database\_ssm\_key\_prefix) | SSM prefix |
 | <a name="output_vpc_security_group_ids"></a> [vpc\_security\_group\_ids](#output\_vpc\_security\_group\_ids) | The VPC security group IDs associated with the cluster |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
+<!-- prettier-ignore-end -->
 
 ## References
-* [cloudposse/terraform-aws-components](https://github.com/cloudposse/terraform-aws-components/tree/main/modules/redshift) - Cloud Posse's upstream component
 
+- [cloudposse/terraform-aws-components](https://github.com/cloudposse/terraform-aws-components/tree/main/modules/redshift) -
+  Cloud Posse's upstream component
 
 [<img src="https://cloudposse.com/logo-300x69.svg" height="32" align="right"/>](https://cpco.io/component)