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.

Sign up for GitHub

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

Jump to bottom

docs: Update getting-started and main README.md documentation #1755

Merged
merged 1 commit into from
Sep 11, 2023
Merged

docs: Update getting-started and main README.md documentation #1755

merged 1 commit into from
Sep 11, 2023

Conversation

bryantbiggs
Copy link
Contributor

@bryantbiggs bryantbiggs commented Sep 11, 2023 •
edited
Loading

Description

  • Update getting-started and main README.md documentation

Motivation and Context

  • Clarify the consumption model of EKS Blueprints and help users understand how they should think about using and interacting with the project
  • Clarify the Terraform caveats that have been raised by users
  • Provide standard deploy/destroy documentation in the getting started guide so that we can reduce the amount of boilerplate in the pattern's documentation (next PR)

How was this change tested?

  • Yes, I have tested the PR using my local account setup (Provide any test evidence report under Additional Notes)
  • Yes, I have updated the docs for this feature
  • Yes, I ran pre-commit run -a with this PR

Additional Notes

image

@bryantbiggs bryantbiggs requested a review from a team as a code owner September 11, 2023 19:33
@bryantbiggs bryantbiggs temporarily deployed to EKS Blueprints Test September 11, 2023 19:33 — with GitHub Actions Inactive
@bryantbiggs bryantbiggs merged commit be44552 into main Sep 11, 2023
29 checks passed
@bryantbiggs bryantbiggs deleted the chore/consolidate-pre-requisites branch September 11, 2023 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@askulkarni2 askulkarni2 askulkarni2 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@bryantbiggs @askulkarni2