grafana/pyroscope

Add link to docs with (i) icon

Open

Aperta il 14 dic 2023

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

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

Tech stack
reactjavascript
Dominio
frontend
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
under 1 hour
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
basic frontend developmentfamiliarity with Grafana Pyroscope UI
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85
Direzione di ricerca
Examine the existing profile metrics.json file at public/app/constants/profile metrics.json and the UI component that displays profile types. Add a new field (e.g., 'docUrl') to relevant entries in the JSON, then update the UI component to show an (i) icon that links to the corresponding Grafana documentation. Consult the Grafana docs link provided for CPU profiling to understand the pattern.