grafana/pyroscope

Add link to docs with (i) icon

Open

#2853 aperta il 14 dic 2023

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)C (528 fork)batch import
good first issuetype/docs

Metriche repository

Star
 (9041 star)
Metriche merge PR
 (Merge medio 5g 7h) (62 PR mergiate in 30 g)

Descrizione

image

We created some docs around how to understand profile types here: https://grafana.com/docs/pyroscope/next/ingest-and-analyze-profile-data/profiling-types/#cpu-profiling

and we also have the corresponding label in the profile-metrics.json file here: https://github.com/grafana/pyroscope/blob/main/public/app/constants/profile-metrics.json#L86-L91

Sometimes a user may want to learn more about a profile type so it would be nice if there was a little (i) icon here which would explain more about a profile type for the user.

this could be done by adding another field to the profile-metrics.json file which would link to the relevant entry in the grafana profile types documentation

Guida contributor

Direzione di ricerca
Esplora il file profile metrics.json per comprendere i campi esistenti, quindi aggiungi un nuovo campo 'docsLink' con l'URL alla documentazione Grafana corrispondente. Modifica il componente UI che visualizza i tipi di profilo per mostrare un'icona informativa che apre il collegamento.
Tech stack
typescriptreact
Dominio
frontend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitJSON
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
78