grafana/pyroscope

Add link to docs with (i) icon

Open

#2,853 opened on Dec 14, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C (528 forks)batch import
good first issuetype/docs

Repository metrics

Stars
 (9,041 stars)
PR merge metrics
 (Avg merge 3d 5h) (84 merged PRs in 30d)

Description

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

Research direction
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.
Tech stack
reactjavascript
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
basic frontend developmentfamiliarity with Grafana Pyroscope UI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85