docs: add identity properties to readme #252
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
Document all existing properties/variables in chart readme. Fix some documentations in values file.
lenaschoenburg
approved these changes
Mar 29, 2022
charts/ccsm-helm/README.md
Outdated
| | | `enabled` | If true, the identity deployment and its related resources are deployed via a helm release | `true` | | ||
| | | `image` | Configuration to configure the identity image specifics | | | ||
| | | `image.repository` | Defines which image repository to use | `camunda/identity` | | ||
| | | `image.tag` | Can be set to overwrite the global tag, which should be used in that chart | | |
There was a problem hiding this comment.
Suggested change
| | | `image.tag` | Can be set to overwrite the global tag, which should be used in that chart | | | |
| | | `image.tag` | Defines which image tag to use, overwrites the global tag | | |
There was a problem hiding this comment.
Actually this is optional since the global tag is always set, which defines for all services the version (normally they have all the same version :D )
There was a problem hiding this comment.
Yeah, that part was clear to me 👍 I found the original wording a bit confusing because I read it as "the global tag which should be used in that chart" which didn't make sense to me.
Co-authored-by: Ole Schönburg <ole.schoenburg@gmail.com>
Co-authored-by: Ole Schönburg <ole.schoenburg@gmail.com>
Co-authored-by: Ole Schönburg <ole.schoenburg@gmail.com>
|
Thanks for your fast review @oleschoenburg ❤️ |
Co-authored-by: Ole Schönburg <ole.schoenburg@gmail.com>
Zelldon
commented
Mar 29, 2022
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.
Document all existing properties/variables for identity in chart README.
Fix some documentations in values file.
Generated draft via https://github.com/camunda/camunda-platform-helm/blob/main/charts/ccsm-helm/convertValuesDoc.sh and iterated over documentation. Followed https://github.com/camunda/camunda-platform-helm/blob/main/CONTRIBUTING.md#documentation regarding documentation best practices
related #127