getredash/redash

Provide help strings for Data Source configuration fields

Open

Aperta il 6 mag 2019

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (24.845 star) (4236 fork)batch import
Frontendenhancementhelp wanted

Descrizione

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.

Guida contributor

Tech stack
pythonreactjavascript
Dominio
frontend
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Familiarity with Redash's data source configurationBasic React knowledgePython backend knowledge
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70
Direzione di ricerca
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.