Skip to content
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.

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

feat: Automatically generate Helm Chart docs. Fixes #3356 #3363

Merged
merged 3 commits into from
Jan 21, 2024

Conversation

terrytangyuan
Copy link
Member

Fixes #3356.

Steps:

  1. Install pre-commit: https://pre-commit.com/#install
  2. Install helm-docs: https://github.com/norwoodj/helm-docs#installation
  3. Run pre-commit install; pre-commit run --all or git commit once pre-commit hook is installed.

Signed-off-by: Yuan Tang <terrytangyuan@gmail.com>
Signed-off-by: Yuan Tang <terrytangyuan@gmail.com>
Signed-off-by: Yuan Tang <terrytangyuan@gmail.com>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is intentionally empty to make helm-docs happy

@@ -0,0 +1,18 @@
{{ template "chart.header" . }}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These gotmpl files are used to add custom installation instructions

@terrytangyuan
Copy link
Member Author

terrytangyuan commented Jan 17, 2024

TODOs once this is merged:

  • Update website to mention Helm installation
  • Update contributing docs to include instructions
  • Update release docs to include this step

@terrytangyuan
Copy link
Member Author

/assign @yuzisun

@yuzisun
Copy link
Member

yuzisun commented Jan 21, 2024

/lgtm
/approve

@oss-prow-bot oss-prow-bot bot added the lgtm label Jan 21, 2024
Copy link

oss-prow-bot bot commented Jan 21, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: terrytangyuan, yuzisun

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@oss-prow-bot oss-prow-bot bot merged commit b634922 into kserve:master Jan 21, 2024
58 checks passed
@terrytangyuan terrytangyuan deleted the helm-docs branch January 21, 2024 18:55
timothyjlaurent pushed a commit to timothyjlaurent/kserve that referenced this pull request Feb 21, 2024
…ve#3363)

* generate docs

Signed-off-by: Yuan Tang <terrytangyuan@gmail.com>

* fix

Signed-off-by: Yuan Tang <terrytangyuan@gmail.com>

* fix

Signed-off-by: Yuan Tang <terrytangyuan@gmail.com>

---------

Signed-off-by: Yuan Tang <terrytangyuan@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automatically generate Helm Chart docs
2 participants