Zain-ul-Abdin45 opened a new pull request, #74248:
URL: https://github.com/apache/airflow/pull/74248

   
   The core docs mention configuration sections and options as plain literals, 
such as ``` ``[core] dags_folder`` ``` or ``` ``[secrets]`` ```, so readers 
can't click through to the option's entry in the configuration reference.
   
   This PR converts those mentions to `:ref:` links to the `config:` labels 
that the configuration reference already generates (`config:<section>` and 
`config:<section>__<option>`). It uses the existing syntax, which the docs 
already use in about 60 places, rather than adding a new role.
   
   - ``` ``[section] option`` ``` → ``:ref:`[section] option 
<config:section__option>` ``, only where the pair exists in `config.yml` (100 
conversions)
   - ``` ``[section]`` ``` → ``:ref:`[section] <config:section>` ``, only where 
the section exists in `config.yml` (57 conversions)
   
   49 files under `airflow-core/docs` are changed, with text only.
   
   Intentionally left out:
   - Mentions in section headings and code blocks, so anchors and the table of 
contents don't change.
   - Provider sections (`[celery]`, `[fab]`): their reference pages live in the 
provider docs and need cross-package refs, so they're better as a follow-up.
   - `[mysqld]`: a MySQL server setting, not an Airflow option.
   - `[task_state_store]`: it appears in a note saying the section isn't called 
that.
   - The two mentions inside the metrics table in `metric_tables.rst`, to keep 
the table columns unchanged.
   
   Testing: `breeze build-docs --package-filter apache-airflow --docs-only` 
completes with 0 warnings and no undefined-label messages. I also checked the 
diff for nested `:ref:` markup and unbalanced backticks.
   
   This follows the approach of #73667, which its author closed without review.
   
   closes: #10260
   
   ---
   
   ##### Was generative AI tooling used to co-author this PR?
   
   - [X] Yes (please specify the tool below)
   
   Generated-by: Claude Code following [the 
guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#gen-ai-assisted-contributions)
   
   ---
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to