spiffe/helm-charts

Add helm-docs documentation comments to values.yaml files

Open

#36 opened on Feb 22, 2023

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Smarty (22 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (20 stars)
PR merge metrics
 (PR metrics pending)

Description

To improve documentation of the values, we should include some comments in the style # -- description of value to document the different values in the charts.

See https://github.com/norwoodj/helm-docs for more details on usage.

Run ./helm-docs.sh to update the README.md with enhanced documentation.

Contributor guide

Research direction
Read the helm docs documentation to understand the comment format (# description), then add such comments to values.yaml files in the charts. Finally, run ./helm docs.sh to update README.md.
Tech stack
kubernetes
Domain
documentationdevops
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
YAMLHelm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90