You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "Zain-ul-Abdin45 (via GitHub)" <gi...@apache.org> on 2026/10/05 14:07:43 UTC

[PR] Link configuration option mentions in core docs to the configuration reference [airflow]

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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Link configuration option mentions in core docs to the configuration reference [airflow]

Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #74248:
URL: https://github.com/apache/airflow/pull/74248#issuecomment-5996145915

   Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our [Contributors' Guide](https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
   Here are some useful points:
   - Pay attention to the quality of your code (ruff, mypy and type annotations). Our [prek-hooks]( https://github.com/apache/airflow/blob/main/contributing-docs/08_static_code_checks.rst#prerequisites-for-prek-hooks) will help you with that.
   - In case of a new feature add useful documentation (in docstrings or in `docs/` directory). Adding a new operator? Check this short [guide](https://github.com/apache/airflow/blob/main/airflow-core/docs/howto/custom-operator.rst) Consider adding an example Dag that shows how users should use it.
   - Consider using [Breeze environment](https://github.com/apache/airflow/blob/main/dev/breeze/doc/README.rst) for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
   - Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
   - Please follow [ASF Code of Conduct](https://www.apache.org/foundation/policies/conduct) for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
   - Be sure to read the [Airflow Coding style]( https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#coding-style-and-best-practices).
   - Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
   Apache Airflow is a community-driven project and together we are making it better 🚀.
   In case of doubts contact the developers at:
   Mailing List: dev@airflow.apache.org
   Slack: https://s.apache.org/airflow-slack
   


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Link configuration option mentions in core docs to the configuration reference [airflow]

Posted by "github-actions[bot] (via GitHub) via commits" <co...@airflow.apache.org>.
github-actions[bot] commented on PR #74248:
URL: https://github.com/apache/airflow/pull/74248#issuecomment-7053940990

   This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your 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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org