spiffe/helm-charts

Add helm-docs documentation comments to values.yaml files

Ouverte

#36 ouverte le 22 févr. 2023

Voir sur GitHubGuide contributeur
 (2 commentaires) (1 réaction) (0 personne assignée)Smarty (22 forks)auto 404
documentationgood first issue

Métriques du dépôt

Stars
 (20 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Lisez la documentation de helm docs pour comprendre le format des commentaires (# description), puis ajoutez ces commentaires aux fichiers values.yaml dans les charts. Enfin, exécutez ./helm docs.sh pour mettre à jour le README.md.
Stack technique
kubernetes
Domaine
documentationdevops
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
YAMLHelm
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90