Skip to content

Standardize connection docs labels across providers#63455

Merged
potiuk merged 6 commits into
apache:mainfrom
harshith-21:docs_labels
Mar 14, 2026
Merged

Standardize connection docs labels across providers#63455
potiuk merged 6 commits into
apache:mainfrom
harshith-21:docs_labels

Conversation

@harshith-21
Copy link
Copy Markdown
Contributor

Tried to standardize howto/connection:{conn_type} labels in provider .rst docs to match provider.yaml connection-type values as suggested in following issue.

Closes: #63348


Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)

Generated-by: Cursor/Claude following the guidelines


  • Read the Pull Request Guidelines for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
  • For fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
  • When adding dependency, check compliance with the ASF 3rd Party License Policy.
  • For significant user-facing changes create newsfragment: {pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.

Comment thread providers/apache/spark/docs/connections/spark-connect.rst Outdated
Comment thread providers/apache/spark/docs/connections/spark-submit.rst Outdated
Copy link
Copy Markdown
Contributor

@josh-fell josh-fell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some other places where there are multiple connection doc tags in providers. You should also make sure any other references in any of the docs that might reference the existing labels are updated too.

Looks like a good start on a cleanup effort!

Comment thread providers/dbt/cloud/docs/connections.rst Outdated
@kaxil
Copy link
Copy Markdown
Member

kaxil commented Mar 12, 2026

Also like we discussed on Slack (I think), please create a pre-commit/prek hook (or crete/update existing Sphinx extensions) to ensure it follows this convention

@harshith-21
Copy link
Copy Markdown
Contributor Author

hi @kaxil, just to confirm: the pre-commit hook should make sure that the connection-type in provider.yaml, the title anchor in the corresponding .rst documentation file, and the references to it all use the same value, right ?

@kaxil
Copy link
Copy Markdown
Member

kaxil commented Mar 12, 2026

hi @kaxil, just to confirm: the pre-commit hook should make sure that the connection-type in provider.yaml, the title anchor in the corresponding .rst documentation file, and the references to it all use the same value, right ?

Yup

@harshith-21
Copy link
Copy Markdown
Contributor Author

harshith-21 commented Mar 13, 2026

hi @kaxil, ive added the prek hook which checks if the anchors and references are valid.
I was able to do a quick test with fake conn anchor which failed as follows,

Validate connection doc labels match provider.yaml.............................................Failed
- hook id: check-connection-doc-labels
- exit code: 1

  ✗ ORPHAN LABEL: providers/pgvector/docs/connections.rst — 'howto/connection:fake_conn_type' does not match any connection-type in provider.yaml
    ✗ MULTIPLE LABELS: providers/pgvector/docs/connections.rst — found 2 top-level labels (pgvector, fake_conn_type), expected at most 1

  Connection doc label check failed with 2 error(s).

@kaxil
Copy link
Copy Markdown
Member

kaxil commented Mar 13, 2026

Could you rebase on main to see if it fixes CI errors

@kaxil
Copy link
Copy Markdown
Member

kaxil commented Mar 14, 2026

@harshith-21 harshith-21 marked this pull request as ready for review March 14, 2026 14:03
@harshith-21 harshith-21 requested a review from kaxil March 14, 2026 14:03
@potiuk
Copy link
Copy Markdown
Member

potiuk commented Mar 14, 2026

nice !

@potiuk potiuk merged commit d22813d into apache:main Mar 14, 2026
257 checks passed
@kaxil
Copy link
Copy Markdown
Member

kaxil commented Mar 15, 2026

@harshith-21 🎉

abhijeets25012-tech pushed a commit to abhijeets25012-tech/airflow that referenced this pull request Apr 9, 2026
* Standardize connection docs labels across providers

* Standardize connection docs labels across providers[2]

* remove duplicates

* Add pre-commit hook

* executable permission

* CI fixes with correct refs in python files
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Standardize connection docs labels (howto/connection:{conn_type}) across all providers

4 participants