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

feat: Add support for snippets, rename examples/ to patterns/ #1754

Merged
merged 2 commits into from
Sep 11, 2023
Merged

feat: Add support for snippets, rename examples/ to patterns/ #1754

merged 2 commits into from
Sep 11, 2023

Conversation

bryantbiggs
Copy link
Contributor

Description

  • Add support for creating snippets. Snippets are commonly used for showing how to configure a specific setting and do not warrant an entire "example"/"pattern". This helps to reduce the amount of code/configuration that is shown to users so that its clear what specific configuration changes are required to enable a certain feature
  • Rename examples/ to patterns/ - the term examples is a carryover from Terraform conventions, but when we talk about blueprints its typically in the context of patterns so this aligns that convention

Motivation and Context

  • These changes are intended to help improve the delivery of information in a more concise and easier to understand format. We are open to feedback/suggestions to continue to improve in this area

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

@bryantbiggs bryantbiggs requested a review from a team as a code owner September 11, 2023 16:15
@bryantbiggs bryantbiggs temporarily deployed to EKS Blueprints Test September 11, 2023 16:15 — with GitHub Actions Inactive
askulkarni2
askulkarni2 approved these changes Sep 11, 2023
View reviewed changes
Copy link
Contributor

@askulkarni2 askulkarni2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love it! Thanks for the PR.

@bryantbiggs bryantbiggs merged commit 8aa4515 into main Sep 11, 2023
1 check failed
@bryantbiggs bryantbiggs deleted the feat/snippets branch September 11, 2023 16:37
praseedasathaye added a commit to praseedasathaye/istio.io that referenced this pull request Sep 12, 2023
@praseedasathaye
updating the link as it was broken due to this change made to folder …
88d5215 
…structure in upstream aws-ia/terraform-aws-eks-blueprints#1754
istio-testing pushed a commit to istio/istio.io that referenced this pull request Sep 12, 2023
@praseedasathaye
Aws eks setup (#13858)
6d6256f 
* adding Amazon EKS with Istio setup to platform-setup page

* adding Amazon EKS with Istio setup to platform-setup page

* updating the test section of the doc

* adding period at the end of description for the error in test

* adding newline at end of file

* changing the weight to make it ordered alphabetically.

* updating the link as it was  broken due to this change made to folder structure in upstream aws-ia/terraform-aws-eks-blueprints#1754
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