Review readme wording #1
Merged
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
|
Applied suggested changes |
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.
This is a quick review of the wording in the README before we go public.
The biggest change is the indentation change to make the list of steps/examples display a bit nicer as a list, as can be previewed here: https://github.com/spreadshirt/k8s-multi-secret-to-file/blob/review-wording/README.md
The rest are a couple small wording changes.
Apart from that we should consider changing the example to generate some kind of fictional config file, as it is right now it looks a bit funny to put a secret into an HTML file, which is clearly an example but would/should never be done in practice.