grafana/pyroscope

Provide better example configuration in repo

Open

#3 835 ouverte le 13 janv. 2025

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)C (528 forks)batch import
good first issuehelp wantedtype/docs

Métriques du dépôt

Stars
 (9 041 stars)
Métriques de merge PR
 (Merge moyen 5j 7h) (62 PRs mergées en 30 j)

Description

I think we should provide a better example config file in ./cmd/pyroscope/pyroscope.yaml.

The configuration page in our docs seem to be tricky to understand, as they use a "reference name" for certain sections, which often is confused by users. (example 1, example 2)

All the options should be commented out, ideally generated from the existing structs.

Guide contributeur

Direction de recherche
Examinez l'exemple de configuration existant dans ./cmd/pyroscope/pyroscope.yaml et les définitions de struct dans le code source Go qui génèrent la référence de configuration. Déterminez comment générer automatiquement des options commentées à partir des structs, en veillant à ce que toutes les options soient présentes avec des commentaires clairs. Vérifiez les issues connexes (par exemple, #3790) et la discussion sur Slack concernant la confusion des utilisateurs. Consultez les commentaires des mainteneurs dans cette issue pour le format de sortie attendu.
Stack technique
go
Domaine
backend
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.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
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
Go
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75