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

Create a smaller scale reference architecture example to highlight boilerplate features #88

Merged
merged 5 commits into from
Mar 4, 2022

Conversation

yorinasub17
Copy link
Contributor

@yorinasub17 yorinasub17 commented Feb 17, 2022

Description

This PR moves all the existing examples to the examples/for-learning-and-testing folder, and adds in a full fledged examples/for-production folder. I recommend viewing the examples folder in the github browser to review this: https://github.com/gruntwork-io/boilerplate/tree/feature/for-production-example

This is the start of addressing #85, by providing a smaller scale, but complete example of how boilerplate templates in production should look like. This new example should demonstrate a lot of the patterns we invented in the Architecture Catalog in a more digestable format that is hopefully easier to follow and explain.

In the future, we can build a tutorial that works our way towards this end result.

TODOs

Please ensure all of these TODOs are completed before asking for a review.

  • Ensure the branch is named correctly with the issue number. e.g: feature/new-vpc-endpoints-955 or bug/missing-count-param-434.
  • Update the docs.
  • Keep the changes backward compatible where possible.
  • Run the pre-commit checks successfully.
  • Run the relevant tests successfully.

zackproser
zackproser previously approved these changes Mar 1, 2022
@yorinasub17 yorinasub17 force-pushed the feature/for-production-example branch from 07a8eb9 to e343254 Compare March 2, 2022 17:01
Copy link
Contributor

@rhoboat rhoboat left a comment

Choose a reason for hiding this comment

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

I love it! The addition of for-production examples is wonderful. NIT: Is it worth explaining a little about the ordering? i.e., reference-architecture blueprint is first, then the reference-architecture-app-account for each of those, etc? Or at least point to the entry point blueprint, so that it's easy to then cascade / follow the references down to the end?

@yorinasub17
Copy link
Contributor Author

NIT: Is it worth explaining a little about the ordering?

That probably makes sense. Let me merge this in because I am running into frequent merge conflicts due to the folder change in the examples, and then will push an iteration for the docs.

@yorinasub17
Copy link
Contributor Author

yorinasub17 commented Mar 4, 2022

Thanks for review! (Intentionally keeping branch since I shared the link to the branch with Deloitte for feedback, and don't want them to get a 404)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants