Fixup examples in README.md #324
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
* Conformitron uses AWS Secret Store, and most of the README refers to Secret Store, but the local testing ClusterSecretStores example in the README used Parameter Store instead. This could cause confusion for people not familiar with setting up External Secrets. Fix is to specify SecretStore in the example. * The Flux Kustomization directions for local testing used the same kustomization name for the addon definition and also for its test. This is likely to cause Flux to replace the existing kustomization with the test path, deleting the addon resources themselves. Fix is to use a different name for the testing kustomization.
|
Merging the ReadMe Fix. |
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.
Description of changes:
Fixes two minor issues in the README.md file.
Conformitron uses AWS Secret Store, and most of the README refers to Secret Store, but the local testing ClusterSecretStores example in the README used Parameter Store instead. This could cause confusion for people not familiar with setting up External Secrets. Fix is to specify SecretStore in the example.
The Flux Kustomization directions for local testing used the same kustomization name for the addon definition and also for its test. This is likely to cause Flux to replace the existing kustomization with the test path, deleting the addon resources themselves. Fix is to use a different name for the testing kustomization.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.