SigNoz/signoz

Render dashboard description text as HTML content?

Open

#5,256 opened on Jun 18, 2024

View on GitHub
 (2 comments) (0 reactions) (1 assignee)TypeScript (976 forks)batch import
dashboardsenhancementfrontendgood first issue

Repository metrics

Stars
 (16,037 stars)
PR merge metrics
 (Avg merge 5d 13h) (222 merged PRs in 30d)

Description

If I paste the link in description it is not usuable.

Contributor guide

Research direction
The issue requests that dashboard description text be rendered as HTML to make links clickable. Check the frontend code in the dashboard component, likely using a Markdown or plain text renderer. Look at files like 'frontend/src/container/DashboardDescription/index.tsx' for current implementation. Consider using a library like react markdown or sanitizing HTML with DOMPurify. The issue is straightforward but requires careful handling of XSS risk. Commenters may have provided additional context.
Tech stack
typescriptreact
Domain
frontendobservability
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
React knowledgeUnderstanding of dangerouslySetInnerHTML or DOMPurify
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75