grafana/pyroscope

Add link to docs with (i) icon

Open

#2.853 geöffnet am 14. Dez. 2023

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)C (9.041 Stars) (528 Forks)batch import
good first issuetype/docs

Beschreibung

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

Contributor Guide

Tech Stack
reactjavascript
Domain
frontend
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
basic frontend developmentfamiliarity with Grafana Pyroscope UI
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85
Research-Richtung
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.