From ffb3e5671244dc1c41e1bd3f0bbd0f1014ca0eac Mon Sep 17 00:00:00 2001 From: Daniel Dreier Date: Wed, 22 Sep 2021 09:57:47 -0400 Subject: [PATCH 1/6] chore(docs): link docs to Pocket codebase, YouTube --- website/docs/cdktf/examples.html.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/website/docs/cdktf/examples.html.md b/website/docs/cdktf/examples.html.md index 5ebb9107b3..2ad54726da 100644 --- a/website/docs/cdktf/examples.html.md +++ b/website/docs/cdktf/examples.html.md @@ -71,8 +71,23 @@ Follow these hands-on tutorials from HashiCorp Learn: [Write CDK for Terraform C ## Youtube Playlist -TODO Add information here with a link. +* Watch the CDK for Terraform engineering team build a simple end to end serverless application in an [end to end livestream](https://www.youtube.com/watch?v=Ey0SW0c6p8c) +* [Getting Started with CDK for Terraform and Python](https://www.youtube.com/watch?v=Ee2qh-pEC5k&t=258s), by Charles mcLaughlin of ShopStyle +* [Extending constructs of the CDK for Terraform](https://www.youtube.com/watch?v=cfU-WOGdNqA) -## Pocket public codebase? +### Release demos +[0.4: Go support, Asset construct, Terraform Cloud integration](https://www.youtube.com/watch?v=TTfFAIeSqgo). Includes a [GKE demo](https://youtu.be/TTfFAIeSqgo?t=1573). +[0.5: Convert and watch command demos](https://www.youtube.com/watch?v=4caW8WJM4h4&t=1s) +[0.6: snapshot testing](https://www.youtube.com/watch?v=9Is4QJT2664) -TODO Describe what this is and add a link :-) +Constributors interested in extending the `cdktf convert` command may be interested in the [convert deep dive](https://www.youtube.com/watch?v=rSn4-Ki5nho). This is not needed to use it. + +## Pocket public codebase + +Mozilla Pocket is a widely used application for managing reading lists that's built into the Firefox browser. Like many Mozilla projects, Pocket is open source, and the CDK for Terraform codebase that they use to manage infrastructure for their recommendation API is also public and open source. Pocket's codebase provides a great example of how to lay out a CDK for Terraform project. + +In order to re-use components, Pocket's codebase is separated out into a [set of reusable modules](https://github.com/Pocket/terraform-modules/tree/main/src/pocket). These are then used from CDK code in the [recommendation-api codebase](https://github.com/Pocket/recommendation-api/tree/main/.aws). The recommended reading order is to: + +1. Read [`Pocket/recommendation-api/.aws/src/main.ts`](https://github.com/Pocket/recommendation-api/blob/main/.aws/src/main.ts) +2. Look at the constructs used that are defined in the [`Pocket/terraform-modules`](https://github.com/Pocket/terraform-modules/tree/main/src/pocket) repository, such as [`PocketALBApplication`](https://github.com/Pocket/terraform-modules/blob/main/src/pocket/PocketALBApplication.ts) +3. Look at the ["base" constructs](https://github.com/Pocket/terraform-modules/tree/main/src/base), which are are used in the higher-level constructs in the previous step From 650b1f38b77b5cb405bf0f8b51ba3faa7f4485df Mon Sep 17 00:00:00 2001 From: Daniel Dreier Date: Thu, 23 Sep 2021 09:27:26 -0400 Subject: [PATCH 2/6] Update website/docs/cdktf/examples.html.md Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> --- website/docs/cdktf/examples.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cdktf/examples.html.md b/website/docs/cdktf/examples.html.md index 2ad54726da..c0079506d8 100644 --- a/website/docs/cdktf/examples.html.md +++ b/website/docs/cdktf/examples.html.md @@ -78,7 +78,7 @@ Follow these hands-on tutorials from HashiCorp Learn: [Write CDK for Terraform C ### Release demos [0.4: Go support, Asset construct, Terraform Cloud integration](https://www.youtube.com/watch?v=TTfFAIeSqgo). Includes a [GKE demo](https://youtu.be/TTfFAIeSqgo?t=1573). [0.5: Convert and watch command demos](https://www.youtube.com/watch?v=4caW8WJM4h4&t=1s) -[0.6: snapshot testing](https://www.youtube.com/watch?v=9Is4QJT2664) +[0.6: Snapshot testing](https://www.youtube.com/watch?v=9Is4QJT2664) Constributors interested in extending the `cdktf convert` command may be interested in the [convert deep dive](https://www.youtube.com/watch?v=rSn4-Ki5nho). This is not needed to use it. From 138eee71688ef3080eac991dbfeda0cc7a3e3492 Mon Sep 17 00:00:00 2001 From: Daniel Dreier Date: Thu, 23 Sep 2021 09:27:33 -0400 Subject: [PATCH 3/6] Update website/docs/cdktf/examples.html.md Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> --- website/docs/cdktf/examples.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cdktf/examples.html.md b/website/docs/cdktf/examples.html.md index c0079506d8..1078923efd 100644 --- a/website/docs/cdktf/examples.html.md +++ b/website/docs/cdktf/examples.html.md @@ -84,7 +84,7 @@ Constributors interested in extending the `cdktf convert` command may be interes ## Pocket public codebase -Mozilla Pocket is a widely used application for managing reading lists that's built into the Firefox browser. Like many Mozilla projects, Pocket is open source, and the CDK for Terraform codebase that they use to manage infrastructure for their recommendation API is also public and open source. Pocket's codebase provides a great example of how to lay out a CDK for Terraform project. +Mozilla Pocket is a widely used application for managing reading lists that is built into the Firefox browser. Like many Mozilla projects, Pocket is open source, and the CDK for Terraform codebase that Pocket uses to manage infrastructure for the recommendation API is also public and open source. Pocket's codebase provides a great example of how to lay out a CDK for Terraform project. In order to re-use components, Pocket's codebase is separated out into a [set of reusable modules](https://github.com/Pocket/terraform-modules/tree/main/src/pocket). These are then used from CDK code in the [recommendation-api codebase](https://github.com/Pocket/recommendation-api/tree/main/.aws). The recommended reading order is to: From 58946488f11cf7c67aabc4153e664167af9359cf Mon Sep 17 00:00:00 2001 From: Daniel Dreier Date: Thu, 23 Sep 2021 09:27:54 -0400 Subject: [PATCH 4/6] Update website/docs/cdktf/examples.html.md Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> --- website/docs/cdktf/examples.html.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/cdktf/examples.html.md b/website/docs/cdktf/examples.html.md index 1078923efd..b4e407a426 100644 --- a/website/docs/cdktf/examples.html.md +++ b/website/docs/cdktf/examples.html.md @@ -88,6 +88,6 @@ Mozilla Pocket is a widely used application for managing reading lists that is b In order to re-use components, Pocket's codebase is separated out into a [set of reusable modules](https://github.com/Pocket/terraform-modules/tree/main/src/pocket). These are then used from CDK code in the [recommendation-api codebase](https://github.com/Pocket/recommendation-api/tree/main/.aws). The recommended reading order is to: -1. Read [`Pocket/recommendation-api/.aws/src/main.ts`](https://github.com/Pocket/recommendation-api/blob/main/.aws/src/main.ts) -2. Look at the constructs used that are defined in the [`Pocket/terraform-modules`](https://github.com/Pocket/terraform-modules/tree/main/src/pocket) repository, such as [`PocketALBApplication`](https://github.com/Pocket/terraform-modules/blob/main/src/pocket/PocketALBApplication.ts) -3. Look at the ["base" constructs](https://github.com/Pocket/terraform-modules/tree/main/src/base), which are are used in the higher-level constructs in the previous step +1. Read [`Pocket/recommendation-api/.aws/src/main.ts`](https://github.com/Pocket/recommendation-api/blob/main/.aws/src/main.ts). +2. Look at the constructs used that are defined in the [`Pocket/terraform-modules`](https://github.com/Pocket/terraform-modules/tree/main/src/pocket) repository, such as [`PocketALBApplication`](https://github.com/Pocket/terraform-modules/blob/main/src/pocket/PocketALBApplication.ts). +3. Look at the ["base" constructs](https://github.com/Pocket/terraform-modules/tree/main/src/base), which are are used in the higher-level constructs in the previous step. From dc60d702862883303ffddd32f4d08a075f6a8538 Mon Sep 17 00:00:00 2001 From: Daniel Dreier Date: Thu, 23 Sep 2021 09:28:07 -0400 Subject: [PATCH 5/6] Update website/docs/cdktf/examples.html.md Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> --- website/docs/cdktf/examples.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cdktf/examples.html.md b/website/docs/cdktf/examples.html.md index b4e407a426..5ba0944eb6 100644 --- a/website/docs/cdktf/examples.html.md +++ b/website/docs/cdktf/examples.html.md @@ -80,7 +80,7 @@ Follow these hands-on tutorials from HashiCorp Learn: [Write CDK for Terraform C [0.5: Convert and watch command demos](https://www.youtube.com/watch?v=4caW8WJM4h4&t=1s) [0.6: Snapshot testing](https://www.youtube.com/watch?v=9Is4QJT2664) -Constributors interested in extending the `cdktf convert` command may be interested in the [convert deep dive](https://www.youtube.com/watch?v=rSn4-Ki5nho). This is not needed to use it. +If you're interested in extending the `cdktf convert` command, you may be interested in the [convert deep dive](https://www.youtube.com/watch?v=rSn4-Ki5nho). You do not need to watch this video to use the `convert` command successfully. ## Pocket public codebase From 5dc0a997c1e267409622ba707547b444ebff7ea2 Mon Sep 17 00:00:00 2001 From: Daniel Dreier Date: Thu, 23 Sep 2021 09:40:41 -0400 Subject: [PATCH 6/6] fix(docs): clarify CDK for Terraform --- website/docs/cdktf/examples.html.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/website/docs/cdktf/examples.html.md b/website/docs/cdktf/examples.html.md index 5ba0944eb6..12c65174fc 100644 --- a/website/docs/cdktf/examples.html.md +++ b/website/docs/cdktf/examples.html.md @@ -8,6 +8,7 @@ description: "Resources to help you learn CDK for Terraform, including example p # Examples ## Tutorials + Follow these hands-on tutorials from HashiCorp Learn: [Write CDK for Terraform Configurations](https://learn.hashicorp.com/collections/terraform/cdktf) ## Example Projects @@ -71,11 +72,12 @@ Follow these hands-on tutorials from HashiCorp Learn: [Write CDK for Terraform C ## Youtube Playlist -* Watch the CDK for Terraform engineering team build a simple end to end serverless application in an [end to end livestream](https://www.youtube.com/watch?v=Ey0SW0c6p8c) -* [Getting Started with CDK for Terraform and Python](https://www.youtube.com/watch?v=Ee2qh-pEC5k&t=258s), by Charles mcLaughlin of ShopStyle -* [Extending constructs of the CDK for Terraform](https://www.youtube.com/watch?v=cfU-WOGdNqA) +- Watch the CDK for Terraform engineering team build a simple end to end serverless application in an [end to end livestream](https://www.youtube.com/watch?v=Ey0SW0c6p8c) +- [Getting Started with CDK for Terraform and Python](https://www.youtube.com/watch?v=Ee2qh-pEC5k&t=258s), by Charles mcLaughlin of ShopStyle +- [Extending constructs of the CDK for Terraform](https://www.youtube.com/watch?v=cfU-WOGdNqA) ### Release demos + [0.4: Go support, Asset construct, Terraform Cloud integration](https://www.youtube.com/watch?v=TTfFAIeSqgo). Includes a [GKE demo](https://youtu.be/TTfFAIeSqgo?t=1573). [0.5: Convert and watch command demos](https://www.youtube.com/watch?v=4caW8WJM4h4&t=1s) [0.6: Snapshot testing](https://www.youtube.com/watch?v=9Is4QJT2664) @@ -86,7 +88,7 @@ If you're interested in extending the `cdktf convert` command, you may be intere Mozilla Pocket is a widely used application for managing reading lists that is built into the Firefox browser. Like many Mozilla projects, Pocket is open source, and the CDK for Terraform codebase that Pocket uses to manage infrastructure for the recommendation API is also public and open source. Pocket's codebase provides a great example of how to lay out a CDK for Terraform project. -In order to re-use components, Pocket's codebase is separated out into a [set of reusable modules](https://github.com/Pocket/terraform-modules/tree/main/src/pocket). These are then used from CDK code in the [recommendation-api codebase](https://github.com/Pocket/recommendation-api/tree/main/.aws). The recommended reading order is to: +In order to re-use components, Pocket's codebase is separated out into a [set of reusable modules](https://github.com/Pocket/terraform-modules/tree/main/src/pocket). These are then used from CDK for Terraform code in the [recommendation-api codebase](https://github.com/Pocket/recommendation-api/tree/main/.aws). The recommended reading order is to: 1. Read [`Pocket/recommendation-api/.aws/src/main.ts`](https://github.com/Pocket/recommendation-api/blob/main/.aws/src/main.ts). 2. Look at the constructs used that are defined in the [`Pocket/terraform-modules`](https://github.com/Pocket/terraform-modules/tree/main/src/pocket) repository, such as [`PocketALBApplication`](https://github.com/Pocket/terraform-modules/blob/main/src/pocket/PocketALBApplication.ts).