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.