Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Gabeaws/docs/getting started updates #357

Merged
merged 2 commits into from
Oct 18, 2024

Conversation

gabebatista
Copy link
Contributor

@gabebatista gabebatista commented Oct 10, 2024

Issue number: #355

Summary

Updates documentation for getting started with the simple build pipeline sample and adds missing defaults packer template.

Changes

  • added warnings regarding the region variable in packer templates as they default to us-west-2 and can cause errors.
  • Changed Packer commands to proper syntax in getting started docs
  • Changed the Note admonition in the Amazon Linux 2023 ARM based Amazon Machine Image section to a warning, as not heading that admonition would cause the command to fail.
  • Added defaults to the vpc_id and subnet_id variables in amazon-linux-2023-arm64.pkr.hcl, allowing Packer to default to the default VPC if no value is passed in.
  • Renamed the fully_qualified_domain_name reference inStep 5. Configure Simple Build Pipeline Variables to root_domain_name to align with name change in code.
  • Split Step 5. Configure Simple Build Pipeline Variables section into local.tf and variables.tf paragraphs to align with module structure.

User experience

Fixes faulty code and clarifies sections which are most likely to cause issues for users.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

  • I have performed a self-review of this change
  • Changes have been tested
  • Changes are documented
Is this a breaking change? No

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created might not be successful.

@gabebatista gabebatista added documentation Improvements or additions to documentation samples Updates to project samples packer Work related to Packer templates labels Oct 10, 2024
@gabebatista gabebatista self-assigned this Oct 10, 2024
@gabebatista gabebatista requested a review from a team as a code owner October 10, 2024 16:27
@gabebatista gabebatista linked an issue Oct 10, 2024 that may be closed by this pull request
1 task
@henrykie
Copy link
Contributor

closes #355 @gabebatista ?

henrykie
henrykie previously approved these changes Oct 10, 2024
@henrykie henrykie force-pushed the gabeaws/docs/getting-started-updates branch from e98d05c to 907db37 Compare October 14, 2024 16:07
@henrykie henrykie requested review from kylesomers and removed request for jorisdon October 14, 2024 16:07
docs/getting-started.md Show resolved Hide resolved
docs/getting-started.md Outdated Show resolved Hide resolved
@gabebatista gabebatista force-pushed the gabeaws/docs/getting-started-updates branch from ad07d47 to bb22428 Compare October 18, 2024 18:05
@gabebatista gabebatista dismissed kylesomers’s stale review October 18, 2024 18:06

Addressed in comment.

@gabebatista gabebatista merged commit 2cae90b into main Oct 18, 2024
3 checks passed
@gabebatista gabebatista deleted the gabeaws/docs/getting-started-updates branch October 18, 2024 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation packer Work related to Packer templates samples Updates to project samples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Update Sample-Build-Pipeline Getting Started Documentation
4 participants