apache / apache/airflow

Automatic reference to configuration reference docs

Open
#10,260 8 comments 1 reaction 0 assignees View on GitHub
good first issue kind:documentation kind:feature
Dominant language
Python
Stars
46.9k
Forks
17.8k
Avg merge
2d 9h
Merged PRs (30d)
472

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.
Screenshot 2020-08-09 at 13 48 55
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](https://github.com/apache/airflow/blob/master/docs/configurations-ref.rst), 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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.