inveniosoftware / inveniosoftware/helm-invenio

Providing documentation and schema

Open
#116 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Go Template
Stars
13
Forks
32
PR merge metrics
No merged PRs in 30d

Description

It would be good to have a complete description of each value in the values.yaml like bitnami does with their charts (readme-generator-for-helm). A schema for the values.yaml is in my opinion also absolutely essential to enable productive deployments as the schema is also used by helm lint.

- https://helm.sh/docs/topics/charts/#schema-files

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inspecting values.yaml and the Helm schema files documentation linked in the issue, then review readme-generator-for-helm for the expected documentation format. The work is complete when every values.yaml option is described and a schema is present and accepted by helm lint.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm
Domain
devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.