getredash/redash

Provide help strings for Data Source configuration fields

Open

#3,772 创建于 2019年5月6日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Python (24,845 star) (4,236 fork)batch import
Frontendenhancementhelp wanted

描述

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.

贡献者指南

技术栈
pythonreactjavascript
领域
frontend
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Familiarity with Redash's data source configurationBasic React knowledgePython backend knowledge
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
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.
Provide help strings for Data Source configuration fields · getredash/redash#3772 | Good First Issue