spiffe/helm-charts

Add helm-docs documentation comments to values.yaml files

Offen

#36 geöffnet am 22.02.2023

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Smarty (22 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (20 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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-Richtung
Lesen Sie die helm docs Dokumentation, um das Kommentarformat (# Beschreibung) zu verstehen, fügen Sie dann solche Kommentare zu den values.yaml Dateien in den Charts hinzu. Führen Sie abschließend ./helm docs.sh aus, um die README.md zu aktualisieren.
Tech Stack
kubernetes
Domain
documentationdevops
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
YAMLHelm
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90