Changed references to Learner Lab to AWS project account.#15
Changed references to Learner Lab to AWS project account.#15applebyter merged 2 commits intomainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the Terraform collaboration guide to refer to a shared team AWS project account (instead of an assignment Learner Lab account) and improves formatting/clarity in a few places to reduce setup mistakes when configuring shared Terraform state.
Changes:
- Reworded account/bucket guidance to reference the team’s shared AWS project account and emphasized key “must match” instructions.
- Reformatted replacement instructions into a bulleted list and adjusted several paragraphs/spacing for readability.
- Updated the backend key example to a project-based prefix and clarified
.gitignoreguidance.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| key = "project-name/terraform.tfstate" | ||
| region = "us-east-1" | ||
| encrypt = true | ||
| use_lockfile = true | ||
| \end{code} | ||
|
|
||
| \noindent | ||
| Replace \texttt{project-name} with the name of your project. |
There was a problem hiding this comment.
The guide now uses two different example state file paths: the earlier overview block shows taskoverflow/terraform.tfstate (State file path), but backend.hcl uses project-name/terraform.tfstate. This is likely to confuse teams about what value to pick and keep consistent. Please make the examples consistent (and, if you intend project-name/..., update the earlier “State file path” example and/or mention it in the replacement list).
| key = "project-name/terraform.tfstate" | |
| region = "us-east-1" | |
| encrypt = true | |
| use_lockfile = true | |
| \end{code} | |
| \noindent | |
| Replace \texttt{project-name} with the name of your project. | |
| key = "taskoverflow/terraform.tfstate" | |
| region = "us-east-1" | |
| encrypt = true | |
| use_lockfile = true | |
| \end{code} | |
| \noindent | |
| Replace \texttt{taskoverflow} with the name of your project. |
| @@ -188,7 +197,7 @@ \section{Step 4: Ignore Local Files} | |||
| Commit \texttt{backend.tf}. | |||
| You may commit \texttt{backend.hcl} if it only contains the team bucket name and no secrets. | |||
| If each student needs different local settings, | |||
| commit \texttt{backend.example.hcl} instead and keep \texttt{backend.hcl} ignored. | |||
| commit \texttt{backend.example.hcl} instead and add \texttt{backend.hcl} to \texttt{.gitignore}. | |||
There was a problem hiding this comment.
The .gitignore example shown here does not include backend.hcl, but later the guide instructs students to “add backend.hcl to .gitignore”. Either add backend.hcl to the example .gitignore block or clarify that it’s only needed in the per-student-settings case (and keep the example aligned with that guidance).
| Replace \texttt{123456789012} with the AWS account ID from your team's assignment Learner Lab. | ||
| Replace \texttt{us-east-1} with the AWS region your team is using. | ||
| Replace \texttt{t00} with your team number. | ||
| Replace |
There was a problem hiding this comment.
This reads as a sentence fragment (“Replace” followed by a list). Consider changing it to something like “Replace:” or “Replace the following values:” to make the instruction grammatically complete.
| Replace | |
| Replace: |
Changed references to the team's assignment learner lab to being the "shared AWS account allocated to the team."
A few other minor updates for formatting or clarification.