Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat: add helm documentation and modernize Chart.yaml #706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
standardloop wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: add helm documentation and modernize Chart.yaml #706

standardloop wants to merge 2 commits into from

Conversation

@standardloop
Copy link

@standardloop standardloop commented Oct 26, 2025

Goal

This PR aims to improve following

Give an appVersion to Chart.yaml

When installing the chart as it is now, the following is shown with a helm list

helm list
NAME    NAMESPACE       REVISION        UPDATED                                 STATUS          CHART           APP VERSION
sloth   sloth           1               2025-10-26 14:02:39.0679 +0800 CST      deployed        sloth-0.14.0

The appVersion section is missing

Create a helm README and autogenerate docs

There is currently no README for helm, these are helpful to see what values can be passed and how to install the chart.

This MR autogenerates the README using helm-docs by creating README.md.gotmpl and adding a Makefile command to run helm-docs render it. This is the standard across many helm tools.

Misc Changes

In Chart.yaml change home to be website homepage and add sources to link to the github repo

@standardloop standardloop requested a review from slok as a code owner October 26, 2025 06:19
@standardloop
Copy link
Author

standardloop commented Oct 26, 2025

Open to feedback on how we want to integrate updating docs into the release process. Please let me know!

@standardloop
Copy link
Author

standardloop commented Nov 2, 2025

merge conflicts have been fixed

@slok
Copy link
Owner

slok commented Nov 9, 2025

Hi @standardloop, thanks for the contribution.

Could you help me understanding this documentation, as it seems to me redundant to checking the values.yml and https://sloth.dev/ (where the docs should be).

@standardloop standardloop mentioned this pull request Nov 9, 2025
Open
@standardloop
Copy link
Author

standardloop commented Nov 9, 2025

Hi @standardloop, thanks for the contribution.

Could you help me understanding this documentation, as it seems to me redundant to checking the values.yml and https://sloth.dev/ (where the docs should be).

@slok

Are you asking why have a README for the helm chart in the repo instead of on the website here:
https://sloth.dev/introduction/install/#kubernetes ?

I just opened an MR that renders with README on the website:

The README of the helm chart should be the source of truth and all other places should be rendering it.

Doc websites

Here is an example with a different application external-dns:

One finds the documentaion:
https://kubernetes-sigs.github.io/external-dns/v0.19.0/charts/external-dns/

And the chart section is just rendering the same README from the github chart
https://github.com/kubernetes-sigs/external-dns/tree/master/charts/external-dns

Here is there code to do that:
https://github.com/kubernetes-sigs/external-dns/blob/master/mkdocs.yml#L10-L11

The README is also the same as the one on artifact hub is rendering:
https://artifacthub.io/packages/helm/external-dns/external-dns

Current flow

There is no helm chart README so no refernces (artifact hub, docs website) can render it

I typically use Artifact Hub to know what version is up to date and what the values for a chart.
I saw this one on Artifact Hub: https://artifacthub.io/packages/helm/sloth/sloth

Looks like a different account uploads your charts. I used that link before, but there was no documenation on the page, it is blank.

I also noticed on your website there isn't too much documenation on the chart values itself.

@standardloop
Copy link
Author

standardloop commented Dec 15, 2025

@slok any update on this one?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@slok slok Awaiting requested review from slok slok is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@standardloop @slok