[PR #4] [MERGED] feature: adding helm-docs #122

Closed
opened 2026-02-15 19:16:30 -05:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/helm-charts/pull/4
Author: @robrakaric
Created: 5/6/2024
Status: Merged
Merged: 5/6/2024
Merged by: @tjbck

Base: mainHead: feature-helm-docs


📝 Commits (1)

📊 Changes

2 files changed (+128 additions, -0 deletions)

View changed files

charts/open-webui/README.md (+92 -0)
charts/open-webui/README.md.gotmpl (+36 -0)

📄 Description

To automatically document helm values, this PR proposes to add helm-docs functionality. This is what most Helm consumers will expect to see in a Helm repo.

The documentation template is in charts/open-webui/README.md.gotmpl.

README.md is then generated simply by navigating to the chart directory anywhere in the repo and running helm-docs

Installing helm docs: https://github.com/norwoodj/helm-docs?tab=readme-ov-file#installation


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/helm-charts/pull/4 **Author:** [@robrakaric](https://github.com/robrakaric) **Created:** 5/6/2024 **Status:** ✅ Merged **Merged:** 5/6/2024 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `main` ← **Head:** `feature-helm-docs` --- ### 📝 Commits (1) - [`1130b1e`](https://github.com/open-webui/helm-charts/commit/1130b1e5254fecb5f16df8a2c2c5225be21ccc64) adding helm docs ### 📊 Changes **2 files changed** (+128 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `charts/open-webui/README.md` (+92 -0) ➕ `charts/open-webui/README.md.gotmpl` (+36 -0) </details> ### 📄 Description To automatically document helm values, this PR proposes to add helm-docs functionality. This is what most Helm consumers will expect to see in a Helm repo. The documentation template is in `charts/open-webui/README.md.gotmpl`. `README.md` is then generated simply by navigating to ~~the chart directory~~ anywhere in the repo and running `helm-docs` Installing helm docs: https://github.com/norwoodj/helm-docs?tab=readme-ov-file#installation --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-15 19:16:30 -05:00
yindo closed this issue 2026-02-15 19:16:30 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: open-webui/helm-charts#122