apache/airflow

Automatic reference to configuration reference docs

Open

#10.260 aperta il 9 ago 2020

Vedi su GitHub
 (5 commenti) (1 reazione) (0 assegnatari)Python (16.781 fork)batch import
good first issuekind:documentationkind:feature

Metriche repository

Star
 (44.809 star)
Metriche merge PR
 (Merge medio 7g 18h) (834 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Crea un nuovo ruolo di riferimento Sphinx (es. :conf:`option`) che si colleghi al reference di configurazione. Segui il pattern dell'estensione della documentazione di Django. Aggiorna il template del reference di configurazione e tutte le descrizioni delle guide per utilizzare il nuovo ruolo.
Tech stack
python
Dominio
documentationbackend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonSphinxGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50