getredash/redash

Provide help strings for Data Source configuration fields

Open

#3.772 aberto em 6 de mai. de 2019

Ver no 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.

Guia do colaborador

Pilha de tecnologia
pythonreactjavascript
Domain
frontend
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
half day
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Familiarity with Redash's data source configurationBasic React knowledgePython backend knowledge
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70
Direção de pesquisa
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.