feat: Implement UI element to annotate YAML files #976
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.
What this PR does / why we need it:
This PR adds a new markdown UI element that can be used to break down YAML snippets with annotations to call out each important section and what its doing. This is currently being done in several labs but without much consistency and in generally still requiring a lot of effort for the user to pick through the YAML to match the explanations with parts of the file.
This is an example of the markdown used:
Things to note:
jq
. You can reference specific fields (metadata.name
), whole blocks/multiple lines (spec.template
) and specific items in arrays using numbers (spec.template.spec.containers.0
) as well as fields of them (spec.template.spec.containers.0.name
).The above example will render like this:
Which issue(s) this PR fixes:
N/A
Quality checks
make test module="<module>"
it was successful (see https://github.com/aws-samples/eks-workshop-v2/blob/main/docs/automated_tests.md)By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.