docs: Move examples that are more like test cases to the new tests/
directory; add better example configurations
#3069
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
tests/
directorynodegroup
tonode group
Motivation and Context
examples/
directory has been historically a mix of both demonstrating the various ways in which the provided module(s) can be configured, but also as a means of testing and validating changes. For smaller, more simple module this works ok - but for a larger, complex module such as EKS with all of the various ways one could configure a cluster, its a nightmare for users looking to get started. This PR is the start of splitting apart those two concepts:tests/
directory, and in the future we can explore the use of utilizing the native Terraform testing facilities. These configurations are quite elaborate and far from what you should ever expect to see in the wild - we are aiming to cover the full breadth of functionality that the module(s) provide in this directory in order to test and validate that provided functionalityexamples/
directory. Now, when users look to the example configurations provided, those examples should less complex than what was previously provided and therefore more realistic in terms of a starting point for a clusterThere will be subsequent PRs that will expand on this change as we look to improve the documentation around the module's usability. For example, the next PR will look to introduce a simple mkdocs website where we can start to build out better and more comprehensive documentation around things such as:
Breaking Changes
How Has This Been Tested?
examples/*
to demonstrate and validate my change(s)examples/*
projectspre-commit run -a
on my pull request