getredash/redash

Provide help strings for Data Source configuration fields

Open

#3,772 opened on May 6, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (4,236 forks)batch import
Frontendenhancementhelp wanted

Repository metrics

Stars
 (24,845 stars)
PR merge metrics
 (Avg merge 6d 17h) (2 merged PRs in 30d)

Description

Sometimes it's beneficial to show the user small tips/help paragraph along side the Data Source/Destination configuration field. We can add an optional help parameter to each field, which will render as a ? icon showing the help text on hover.

Contributor guide

Research direction
Examine how data source configuration fields are defined in the backend (Python) and rendered in the frontend (JavaScript). Identify where to add an optional 'help' parameter to field definitions and how to display a tooltip with a '?' icon on hover.
Tech stack
pythonjavascript
Domain
full stack
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65