Repository navigation
fix: add missing CRD link to helm chart readme - #1563
Merged
Merged
Conversation
The README was missing instructions to update / apply the ClickhouseKeeperInstallation CRD.
janeklb
force-pushed
the
jlb/missing-crd
branch
from
November 16, 2024 15:50
01342db to
27dee3a
Compare
Slach
approved these changes
Nov 16, 2024
Collaborator
|
Thanks for your contribution |
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.
Motivation
The helm chart's
README.mdwas missing instructions to update / apply theClickhouseKeeperInstallationCRD.Modifications
kubectl apply ...command for the CHK CRD to chart descriptionREADME.md.gotmpl(see note below)README.mdviahelm-docshelm-docsminimum version comment in./dev/generate_helm_chart.shsince it is no longer neededNote on
README.go.tmplThis PR also includes a new file:
README.md.gotmplThe reason this file is being included is because it allows for strict control over what is included in the final
README.md. The contents of this file are copy-pasted from thehelm-docsdefaults (you can find them below the table here), except for the last template section:This part has been omitted in order to preserve the current
README.mdformat.The same functionality can be achieved by using the
--skip-version-footerflag when callinghelm-docs. I had originally included this indev/generate_helm_chart.shas part of (#1555); however, it was subsequently removed in 3ae32ee by @sunsingerus.Hopefully this approach is more suitable.
Important items to consider before making a Pull Request
Please check items PR complies to:
next-releasebranch, not intomasterbranch1. More info