apache/airflow

Automatic reference to configuration reference docs

Open

#10.260 aberto em 9 de ago. de 2020

Ver no GitHub
 (5 comments) (1 reaction) (0 assignees)Python (16.781 forks)batch import
good first issuekind:documentationkind:feature

Métricas do repositório

Stars
 (44.809 stars)
Métricas de merge de PR
 (Mesclagem média 7d 18h) (834 fundiu PRs em 30d)

Description

Hello,

I would like it to be possible to easily refer to the reference list with configuration options. Currently, most of the guides that require a description of configuration options are similar to the description below. There are code literals in this text: backend, [secrets]. Unfortunately, these literals are just text and I wish they could be clicked to go to a reference list containing a description of the option/section.

To do this, we should add a new reference type, make changes to the listing template, and then make changes to all descriptions. We can be inspired by the Django project. https://github.com/django/django/blob/58a336a674a658c1cda6707fe1cacb56aaed3008/docs/_ext/djangodocs.py#L47-L52

Best regards, Kamil Breguła

Guia do colaborador

Direção de pesquisa
Crie um novo papel de referência Sphinx (como :conf:`option`) que vincule à referência de configuração. Siga o padrão da extensão de documentação do Django. Atualize o modelo de referência de configuração e todas as descrições dos guias para usar o novo papel.
Pilha de tecnologia
python
Domain
documentationbackend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonSphinxGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50