[helm] Rewrite README to point to website docs#2846
Merged
Conversation
morazow
suggested changes
Mar 12, 2026
Contributor
Author
|
@morazow thanks for the review! I opted for a compromise: In In |
This was referenced Mar 12, 2026
wxplovecc
pushed a commit
to tongcheng-elong/fluss
that referenced
this pull request
Apr 17, 2026
wxplovecc
pushed a commit
to tongcheng-elong/fluss
that referenced
this pull request
Apr 20, 2026
polyzos
pushed a commit
that referenced
this pull request
Apr 23, 2026
* [helm] Enable pulling from private Docker registry (#2692) * [helm] Enable pulling from private Docker registry Added instructions for using a private Docker registry and included image values reference. --------- Co-authored-by: xx789 <348448708@qq.com> (cherry picked from commit 43f76a5) * [helm] Fix wrong resource name in coordinator sts (#2834) (cherry picked from commit 2c49fbc) * [helm] Add CI workflow to run Helm tests (#2777) * [helm] Add CI workflow to run Helm tests (cherry picked from commit dd181eb) * [Helm] Chart Component Configuration Isolation (#2472) * Helm Chart Component Configuration Isolation * Retrigger CI tests * Retriggering CI/CD build pipeline (cherry picked from commit d956e75) * [Helm] Revert Chart Component Configuration Isolation (#2472) (#2863) This reverts commit d956e75. (cherry picked from commit 8cd9a6f) * [helm] Enable SASL authentication configurations (#2506) (cherry picked from commit f7e4498) * [helm] Rewrite README to point to website docs (#2846) (cherry picked from commit aa5d166) * [helm][hotfix] Go template whitespace trimming caused exceptions (#2893) * [helm][hotfix] Go template whitespace trimming caused exceptions * Update and use without trimming (cherry picked from commit 22ece48) * [helm] Enable metrics reporting in helm charts (#2711) --- Co-authored-by: Lorenzo Affetti <lorenzo.affetti@gmail.com> (cherry picked from commit 2b207a4) * [helm] Fix .helmignore to not package tests (#2847) (cherry picked from commit d4748f2) * [helm] Enable SASL authenticated connection to Zookeeper nodes (#2700) --- Co-authored-by: Lorenzo Affetti <lorenzo.affetti@gmail.com> (cherry picked from commit bdbbbce) * [helm] Fix Zookeeper client config path (#3015) (cherry picked from commit e9bfd72) * [helm] Fix wrong resource name in coordinator sts (#3044) (cherry picked from commit 8df3873) * [helm] Add extraVolumes, extraVolumeMounts, initContainers (#3034) (cherry picked from commit 17f5400) --------- Co-authored-by: Lorenzo Affetti <lorenzo.affetti@gmail.com> Co-authored-by: xx789 <348448708@qq.com> Co-authored-by: Hemanth Savasere <hemanth.savasere@gmail.com>
Ugbot
pushed a commit
to Ugbot/fluss
that referenced
this pull request
Apr 26, 2026
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
3 participants
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.
Purpose
Linked issue: close #2840
Refactor README to point to official docs to avoid double-edits on changes.
Brief change log
Rewrite the README to point to website docs.
I checked all sections, and the information in the README was either redundant or obsolete compared to the docs.
I would say this is the way to go.
Furthermore I added a section on how to run the tests we recently introduced and contribution guidelines (add tests :) )
Tests
API and Format
Documentation