From b03b5521fe05a4c240861c01c264503b072fcab8 Mon Sep 17 00:00:00 2001 From: Eugene K Date: Mon, 31 Jan 2022 13:05:43 -0500 Subject: [PATCH] Minor typo fixes This PR addresses one small typo in `forking.md` and addresses @jalessio's suggestions in #159 --- .../03-deploy-apps/05-publish-docker-image.md | 32 ++++++++--------- .../guides/working-with-code/forking.md | 2 +- .../03-deploy-apps/05-publish-docker-image.md | 34 +++++++++---------- docs/guides/working-with-code/forking.md | 4 +-- 4 files changed, 36 insertions(+), 36 deletions(-) diff --git a/_docs-sources/guides/reference-architecture/example-usage-guide/03-deploy-apps/05-publish-docker-image.md b/_docs-sources/guides/reference-architecture/example-usage-guide/03-deploy-apps/05-publish-docker-image.md index 526e7dc27f..3263070924 100644 --- a/_docs-sources/guides/reference-architecture/example-usage-guide/03-deploy-apps/05-publish-docker-image.md +++ b/_docs-sources/guides/reference-architecture/example-usage-guide/03-deploy-apps/05-publish-docker-image.md @@ -7,29 +7,29 @@ First, you'll need to create the new ECR repository. 1. Create a new branch on your infrastructure-live repository: `git checkout -b simple-web-app-repo`. 1. Open [`repos.yml` in -`shared/us-west-2/_regional/ecr-repos`](https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/examples/for-production/infrastructure-live/shared/us-west-2/_regional/ecr-repos/repos.yml) and -add the desired repository name of your app. For the purposes of our example, let's call -ours `simple-web-app`: + `shared/us-west-2/_regional/ecr-repos`](https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/examples/for-production/infrastructure-live/shared/us-west-2/_regional/ecr-repos/repos.yml) and + add the desired repository name of your app. For the purposes of our example, let's call + ours `simple-web-app`: - ```yaml - simple-web-app: - external_account_ids_with_read_access: +```yaml +simple-web-app: + external_account_ids_with_read_access: # NOTE: we have to comment out the directives so that the python based data merger (see the `merge-data` hook under # blueprints in this repository) can parse this yaml file. This still works when feeding through templatefile, as it # will interleave blank comments with the list items, which yaml handles gracefully. # %{ for account in accounts } - - '${account}' - # %{ endfor } - external_account_ids_with_write_access: [] - tags: {} - enable_automatic_image_scanning: true - ``` + - "${account}" + # %{ endfor } + external_account_ids_with_write_access: [] + tags: {} + enable_automatic_image_scanning: true +``` 1. Commit and push the change: - ```bash - git add shared/us-west-2/shared/data-stores/ecr-repos/terragrunt.hcl && git commit -m 'Added simple-web-app repo' && git push - ``` +```bash +git add shared/us-west-2/shared/data-stores/ecr-repos/terragrunt.hcl && git commit -m 'Added simple-web-app repo' && git push +``` 1. Now open a pull request on the `simple-web-app-repo` branch. @@ -51,7 +51,7 @@ docker tag simple-web-app:latest 234567890123.dkr.ecr.us-west-2.amazonaws.com/si Next, authenticate your Docker client with ECR in the shared-services account: ```bash -aws ecr get-login-password --region "us-west-2" | docker login --username AWS --password-stdin 234567890123.dkr.ecr.us-east-1.amazonaws.com +aws ecr get-login-password --region "us-west-2" | docker login --username AWS --password-stdin 234567890123.dkr.ecr.us-west-2.amazonaws.com ``` And finally, push your newly tagged image to publish it: diff --git a/_docs-sources/guides/working-with-code/forking.md b/_docs-sources/guides/working-with-code/forking.md index d1fe3be9fa..b47b5a6fa5 100644 --- a/_docs-sources/guides/working-with-code/forking.md +++ b/_docs-sources/guides/working-with-code/forking.md @@ -34,7 +34,7 @@ so you’ll want to pull in these updates as quickly as you can. ## How to use your forked code -Once you’ve forked the code, using it in is very similar to what is outlined in [Using Terraform Modules](/docs/intro/first-deployment/using-terraform-modules), except for the following differences: +Once you’ve forked the code, using it is very similar to what is outlined in [Using Terraform Modules](/docs/intro/first-deployment/using-terraform-modules), except for the following differences: 1. Point the `source` URLs of your Terraform modules to your own Git repos, rather than the `gruntwork-io` GitHub org. 2. Point the `--repo` parameter of `gruntwork-install` to your own Git repos, rather than the `gruntwork-io` GitHub org. diff --git a/docs/guides/reference-architecture/example-usage-guide/03-deploy-apps/05-publish-docker-image.md b/docs/guides/reference-architecture/example-usage-guide/03-deploy-apps/05-publish-docker-image.md index 053801f14c..823328b932 100644 --- a/docs/guides/reference-architecture/example-usage-guide/03-deploy-apps/05-publish-docker-image.md +++ b/docs/guides/reference-architecture/example-usage-guide/03-deploy-apps/05-publish-docker-image.md @@ -7,29 +7,29 @@ First, you'll need to create the new ECR repository. 1. Create a new branch on your infrastructure-live repository: `git checkout -b simple-web-app-repo`. 1. Open [`repos.yml` in -`shared/us-west-2/_regional/ecr-repos`](https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/examples/for-production/infrastructure-live/shared/us-west-2/_regional/ecr-repos/repos.yml) and -add the desired repository name of your app. For the purposes of our example, let's call -ours `simple-web-app`: + `shared/us-west-2/_regional/ecr-repos`](https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/examples/for-production/infrastructure-live/shared/us-west-2/_regional/ecr-repos/repos.yml) and + add the desired repository name of your app. For the purposes of our example, let's call + ours `simple-web-app`: - ```yaml - simple-web-app: - external_account_ids_with_read_access: +```yaml +simple-web-app: + external_account_ids_with_read_access: # NOTE: we have to comment out the directives so that the python based data merger (see the `merge-data` hook under # blueprints in this repository) can parse this yaml file. This still works when feeding through templatefile, as it # will interleave blank comments with the list items, which yaml handles gracefully. # %{ for account in accounts } - - '${account}' - # %{ endfor } - external_account_ids_with_write_access: [] - tags: {} - enable_automatic_image_scanning: true - ``` + - "${account}" + # %{ endfor } + external_account_ids_with_write_access: [] + tags: {} + enable_automatic_image_scanning: true +``` 1. Commit and push the change: - ```bash - git add shared/us-west-2/shared/data-stores/ecr-repos/terragrunt.hcl && git commit -m 'Added simple-web-app repo' && git push - ``` +```bash +git add shared/us-west-2/shared/data-stores/ecr-repos/terragrunt.hcl && git commit -m 'Added simple-web-app repo' && git push +``` 1. Now open a pull request on the `simple-web-app-repo` branch. @@ -51,7 +51,7 @@ docker tag simple-web-app:latest 234567890123.dkr.ecr.us-west-2.amazonaws.com/si Next, authenticate your Docker client with ECR in the shared-services account: ```bash -aws ecr get-login-password --region "us-west-2" | docker login --username AWS --password-stdin 234567890123.dkr.ecr.us-east-1.amazonaws.com +aws ecr get-login-password --region "us-west-2" | docker login --username AWS --password-stdin 234567890123.dkr.ecr.us-west-2.amazonaws.com ``` And finally, push your newly tagged image to publish it: @@ -62,5 +62,5 @@ docker push 234567890123.dkr.ecr.us-west-2.amazonaws.com/simple-web-app:v1 diff --git a/docs/guides/working-with-code/forking.md b/docs/guides/working-with-code/forking.md index 738eed7157..c466bdb50f 100644 --- a/docs/guides/working-with-code/forking.md +++ b/docs/guides/working-with-code/forking.md @@ -34,7 +34,7 @@ so you’ll want to pull in these updates as quickly as you can. ## How to use your forked code -Once you’ve forked the code, using it in is very similar to what is outlined in [Using Terraform Modules](/docs/intro/first-deployment/using-terraform-modules), except for the following differences: +Once you’ve forked the code, using it is very similar to what is outlined in [Using Terraform Modules](/docs/intro/first-deployment/using-terraform-modules), except for the following differences: 1. Point the `source` URLs of your Terraform modules to your own Git repos, rather than the `gruntwork-io` GitHub org. 2. Point the `--repo` parameter of `gruntwork-install` to your own Git repos, rather than the `gruntwork-io` GitHub org. @@ -56,5 +56,5 @@ bans all outside sources, then follow the instructions above to fork the code, a