docs(helm): document supported values and add usage examples#280
Open
chihkang wants to merge 2 commits intoopenabdev:mainfrom
Open
docs(helm): document supported values and add usage examples#280chihkang wants to merge 2 commits intoopenabdev:mainfrom
chihkang wants to merge 2 commits intoopenabdev:mainfrom
Conversation
This file contains hidden or 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
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.
Summary
This PR improves the Helm chart documentation by adding several supported but currently undocumented values to the values reference and README.
Users can already rely on these options in practice, but today they are difficult to discover unless they inspect the chart templates directly. This change makes the chart easier to use and reduces trial-and-error during deployment.
Closes #163.
Changes
fullnameOverridetovalues.yamlnameOverridetovalues.yamlenvFrominvalues.yamlcomments and chart docsagentsMdusage with--set-filediscord.allowedChannels--set-stringrequirement more prominentlyWhy
The chart already supports these configuration paths, but they are not clearly documented. That creates unnecessary friction for users, especially for:
AGENTS.mdconfigurationsNotes
This PR is documentation-focused and does not change chart behavior. It only makes existing supported options easier to discover and use.
Testing
helmCLI was not available in the local environment forhelm lint