kaxil opened a new issue, #63348:
URL: https://github.com/apache/airflow/issues/63348
## Problem
The provider registry resolves connection documentation URLs from Sphinx
inventory files using `howto/connection:{conn_type}` labels. Many providers
have these labels correctly, but some are missing or inconsistent, causing the
registry to fall back to a generic `connections/` page instead of linking to
the specific connection page.
### Current state
Out of ~70 providers with connection types, the registry found:
- **62 conn_types** with exact inventory matches → correct deep link
- **~30 conn_types** with no matching label → falls back to `connections/`
### Examples of missing/inconsistent labels
| Provider | conn_type (provider.yaml) | Expected label | Actual state |
|----------|---------------------------|---------------|-------------|
| Google | `google_cloud_platform` |
`howto/connection:google_cloud_platform` | Missing (page is
`connections/gcp.html` with label `howto/connection:gcp`) |
| Google | `gcpcloudsql` | `howto/connection:gcpcloudsql` | Missing (page is
`connections/gcp_sql.html`) |
| Google | `gcpssh` | `howto/connection:gcpssh` | Missing (page is
`connections/gcp_ssh.html`) |
| Alibaba | `alibaba_cloud` | `howto/connection:alibaba_cloud` | Missing
(page exists as `connections/alibaba.html`) |
| Apache Cassandra | `cassandra` | `howto/connection:cassandra` | Missing
(page exists as `connections/cassandra.html`) |
| Apache Kafka | `kafka` | `howto/connection:kafka` | Missing (page exists
as `connections/kafka.html`) |
| Common AI | `pydanticai` | `howto/connection:pydanticai` | Label is
`pydantic_ai` (underscore vs no underscore) |
| Datadog | `datadog` | `howto/connection:datadog` | Missing |
| Discord | `discord` | `howto/connection:discord` | Missing (page is
`connections/discord-webhook.html`) |
### What needs to happen
For each provider with a connections docs page:
1. **Add `.. _howto/connection:{conn_type}:` label** to the RST file, where
`{conn_type}` exactly matches the `connection-type` value in `provider.yaml`
2. Or **update `provider.yaml`** if the conn_type itself is the inconsistent
value
The `conn_type` value in `provider.yaml` should be the canonical identifier
used everywhere — in the RST label, in the Sphinx inventory, and in
`get_connection_form_widgets()`.
### Context
The registry uses Sphinx `objects.inv` inventory files to resolve connection
page URLs. When a `std:label howto/connection:{conn_type}` entry exists in the
inventory, the registry links directly to that page. Without it, users get a
generic connections listing page.
This was discovered while building the [Provider
Registry](https://airflow.apache.org/registry/) connection docs integration.
--
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]
