Skip to content

fix helm chart's README#1555

Merged
Slach merged 1 commit intoAltinity:0.24.1from
janeklb:jlb/improve-chart-readme
Nov 8, 2024
Merged

fix helm chart's README#1555
Slach merged 1 commit intoAltinity:0.24.1from
janeklb:jlb/improve-chart-readme

Conversation

@janeklb
Copy link
Copy Markdown
Contributor

@janeklb janeklb commented Nov 7, 2024

The helm chart's README is illegible in its current state (this is almost entirely due to the broken configs row in the values table).

This commit adjusts the values.yaml file used to generate the usage table in the README.md file such that, after running ./dev/generate_helm_chart.sh, it correctly (as intended) renders a short message in place of the actual default value for the configs field

Note to reviewer:

Important items to consider before making a Pull Request

Please check items PR complies to:

  • All commits in the PR are squashed. More info
  • The PR is made into dedicated next-release branch, not into master branch1. More info
  • The PR is signed. More info

1 If you feel your PR does not affect any Go-code or any testable functionality (for example, PR contains docs only or supplementary materials), PR can be made into master branch, but it has to be confirmed by project's maintainer.

@janeklb janeklb force-pushed the jlb/improve-chart-readme branch from 38191a8 to 1bcdcf1 Compare November 7, 2024 23:53
@Slach Slach changed the base branch from master to 0.24.1 November 8, 2024 02:18
@Slach Slach self-requested a review November 8, 2024 02:18
Comment thread deploy/helm/clickhouse-operator/README.md
@Slach
Copy link
Copy Markdown
Collaborator

Slach commented Nov 8, 2024

could you resolve conflicts with 0.24.1 branch?

and could you run
dev/generate_helm_chart.sh locally and check the diff for README.md

@janeklb
Copy link
Copy Markdown
Contributor Author

janeklb commented Nov 8, 2024

could you resolve conflicts with 0.24.1 branch?

and could you run dev/generate_helm_chart.sh locally and check the diff for README.md

I intentionally did not set the PR's base to 0.24.1 because i was following the guidelines (no changes to functionality). Will do it though 👍🏻

The helm chart's README is illegible in its current state.

This commit adjusts the `values.yaml` file used to generate the usage table in the README.md file such that
it correctly (as intended) renders a short message in place of the actual default value for the `configs` field

Signed-off-by: Janek Lasocki-Biczysko <[email protected]>
@janeklb janeklb force-pushed the jlb/improve-chart-readme branch from 1bcdcf1 to 93fe75f Compare November 8, 2024 09:53
@janeklb
Copy link
Copy Markdown
Contributor Author

janeklb commented Nov 8, 2024

could you resolve conflicts with 0.24.1 branch?

and could you run dev/generate_helm_chart.sh locally and check the diff for README.md

Done

Comment thread deploy/helm/clickhouse-operator/values.yaml
@Slach Slach merged commit 4ca83ef into Altinity:0.24.1 Nov 8, 2024
@janeklb janeklb deleted the jlb/improve-chart-readme branch November 8, 2024 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants