getredash/redash

Provide help strings for Data Source configuration fields

Open

#3772 opened on May 6, 2019

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

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

Tech stack
pythonreactjavascript
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.
half day
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
Familiarity with Redash's data source configurationBasic React knowledgePython backend knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Explore how data source configuration fields are defined in the backend (likely Python) and rendered in the frontend (React). Look for existing field definitions in the data source schema (e.g., in `redash/destinations/` or `redash/query runner/`). The frontend components for rendering configuration fields are likely in the `client/` directory, possibly a `Field` component. Implement an optional `help` property that renders a tooltip with the help text on hover, using an existing UI library like Ant Design or custom CSS.