getredash/redash

Provide help strings for Data Source configuration fields

Open

#3,772 opened on 2019年5月6日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Python (24,845 stars) (4,236 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.