From 948d347a5516cf666d08b6444709e73f8be1e5cc Mon Sep 17 00:00:00 2001 From: Dan Miller Date: Mon, 11 Mar 2024 10:39:05 -0700 Subject: [PATCH] feat: `prettier` in READMEs (https://github.com/cloudposse/terraform-aws-components/pull/998) --- src/README.md | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/src/README.md b/src/README.md index 50e5b12..b645979 100644 --- a/src/README.md +++ b/src/README.md @@ -1,7 +1,7 @@ # Component: `amplify` -This component is responsible for provisioning -AWS Amplify apps, backend environments, branches, domain associations, and webhooks. +This component is responsible for provisioning AWS Amplify apps, backend environments, branches, domain associations, +and webhooks. ## Usage @@ -101,24 +101,25 @@ components: certificate_verification_dns_record_enabled: false ``` -The `amplify/example` YAML configuration defines an Amplify app in AWS. -The app is set up to use the `Next.js` framework with SSR (server-side rendering) and is linked to the -GitHub repository "https://github.com/cloudposse/amplify-test2". +The `amplify/example` YAML configuration defines an Amplify app in AWS. The app is set up to use the `Next.js` framework +with SSR (server-side rendering) and is linked to the GitHub repository "https://github.com/cloudposse/amplify-test2". -The app is set up to have two environments: `main` and `develop`. -Each environment has different configuration settings, such as the branch name, framework, and stage. -The `main` environment is set up for production, while the `develop` environments is set up for development. +The app is set up to have two environments: `main` and `develop`. Each environment has different configuration settings, +such as the branch name, framework, and stage. The `main` environment is set up for production, while the `develop` +environments is set up for development. -The app is also configured to have custom subdomains for each environment, with prefixes such as `example-prod` and `example-dev`. -The subdomains are configured to use DNS records, which are enabled through the `subdomains_dns_records_enabled` variable. +The app is also configured to have custom subdomains for each environment, with prefixes such as `example-prod` and +`example-dev`. The subdomains are configured to use DNS records, which are enabled through the +`subdomains_dns_records_enabled` variable. -The app also has an IAM service role configured with specific IAM actions, and environment variables set up for each environment. -Additionally, the app is configured to use the Atmos Spacelift workspace, as indicated by the `workspace_enabled: true` setting. +The app also has an IAM service role configured with specific IAM actions, and environment variables set up for each +environment. Additionally, the app is configured to use the Atmos Spacelift workspace, as indicated by the +`workspace_enabled: true` setting. The `amplify/example` Atmos component extends the `amplify/defaults` component. -The `amplify/example` configuration is imported into the `stacks/mixins/stage/dev.yaml` stack config file to be provisioned -in the `dev` account. +The `amplify/example` configuration is imported into the `stacks/mixins/stage/dev.yaml` stack config file to be +provisioned in the `dev` account. ```yaml # stacks/mixins/stage/dev.yaml @@ -132,6 +133,7 @@ You can execute the following command to provision the Amplify app using Atmos: atmos terraform apply amplify/example -s ``` + ## Requirements @@ -225,5 +227,6 @@ atmos terraform apply amplify/example -s | [sub\_domains](#output\_sub\_domains) | DNS records and the verified status for the subdomains | | [webhooks](#output\_webhooks) | Created webhooks | + [](https://cpco.io/component)