add dev setup guide #656
Merged
add dev setup guide #656
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
LikithaVemulapalli
approved these changes
Jun 24, 2022
brycahta
suggested changes
Jun 24, 2022
| export TERMINATOR_NAME=<name> | ||
| export QUEUE_URL=$(./scripts/get-cfn-stack-output.sh "${QUEUE_STACK_NAME}" QueueURL) | ||
|
|
||
| envsubst <resources/terminator.yaml.tmpl >terminator-${TERMINATOR_NAME}.yaml |
There was a problem hiding this comment.
similar to previous section, I think it's better to state what needs to be done (substitution) and let user decide how to do it
There was a problem hiding this comment.
I view this as a how-to guide. When I'm reading a how-to guide I prefer clear and detailed instructions rather than the implementation being left as "an exercise for the reader".
Specifically referencing the use of envsubst: below the code block, alternate instructions are given if the reader does not wish to use that tool.
charts/aws-node-termination-handler-2/templates/node.k8s.aws_terminators.yaml
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Issue #, if available:
Description of changes:
Re-organize files and add instructions for setting up a development environment (see DEVELOPMENT.md).
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.