Skip to content

Conversation

potiuk
Copy link
Member

@potiuk potiuk commented Aug 22, 2021

The documentation of provider packages was rather disconnected
from the apache-airlfow documentation. It was hard to find the
ways how the apache airflow's core extensions are implemented by
the community managed providers - you needed to know what you were
looking for, and you could not find links to the summary of the
core-functionality extended by providers when you were looking at
the functionality (like logging/secret backends/connections/auth)

This PR inroduces much more comprehensive cross-linking between
the airflow core functionalithy and the community-managed providers
that are providing extensions to the core functionality.

Depends on #17767

The ``hook-class-names`` provider's meta-data property has been deprecated and
is now replaced by ``connection-types`` property. This documents the
change.
@boring-cyborg boring-cyborg bot added provider:cncf-kubernetes Kubernetes (k8s) provider related issues area:providers provider:Apache provider:google Google (including GCP) related issues labels Aug 22, 2021
@potiuk
Copy link
Member Author

potiuk commented Aug 22, 2021

This PR implements what we have been discussing in the devlist thread: https://lists.apache.org/x/thread.html/rf3e3beba4dac92adcd2e2f11088f992c23baa1aa43518e9efbb625f8@%3Cdev.airflow.apache.org%3E

There are a number of new pages in the "apache-providers" "Core Extensions" chapter:

Providers-packages main doc:

image

"Core Extensions" provider's page:

image

continued here:

image

Dedicated pages for each functionality - "Writing logs" example:

image

All those pages are inter-linked form the chapters that describe given functionality in the "apache-airflow" - for example "Writing logs" here:

image

The documentation of provider packages was rather disconnected
from the apache-airlfow documentation. It was hard to find the
ways how the apache airflow's core extensions are implemented by
the community managed providers - you needed to know what you were
looking for, and you could not find links to the summary of the
core-functionality extended by providers when you were looking at
the functionality (like logging/secret backends/connections/auth)

This PR inroduces much more comprehensive cross-linking between
the airflow core functionalithy and the community-managed providers
that are providing extensions to the core functionality.
@potiuk potiuk force-pushed the improve-providers-discoverability branch from 49b88db to b6bbe32 Compare August 23, 2021 20:00
@github-actions github-actions bot added the full tests needed We need to run full set of tests for this PR to merge label Aug 23, 2021
@github-actions
Copy link

The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest main at your convenience, or amend the last commit of the PR, and push it with --force-with-lease.

@potiuk potiuk merged commit bcc7665 into apache:main Aug 23, 2021
@potiuk potiuk deleted the improve-providers-discoverability branch August 23, 2021 21:57
eladkal added a commit to eladkal/airflow that referenced this pull request Jun 28, 2022
now that providers>=2.2 there is no need for the hook-class-names any longer.
refrence to apache#17775
potiuk pushed a commit that referenced this pull request Jun 28, 2022
* Remove `hook-class-names` from provider.yaml
now that providers>=2.2 there is no need for the hook-class-names any longer.
refrence to #17775

* fix `airflow/provider.yaml.schema.json` and `provider_info.schema.json`

* undo changes in `provider_info.schema.json`
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Jan 30, 2023
* Remove `hook-class-names` from provider.yaml
now that providers>=2.2 there is no need for the hook-class-names any longer.
refrence to apache/airflow#17775

* fix `airflow/provider.yaml.schema.json` and `provider_info.schema.json`

* undo changes in `provider_info.schema.json`

GitOrigin-RevId: 510a6bab4595cce8bd5b1447db957309d70f35d9
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Sep 18, 2024
* Remove `hook-class-names` from provider.yaml
now that providers>=2.2 there is no need for the hook-class-names any longer.
refrence to apache/airflow#17775

* fix `airflow/provider.yaml.schema.json` and `provider_info.schema.json`

* undo changes in `provider_info.schema.json`

GitOrigin-RevId: 510a6bab4595cce8bd5b1447db957309d70f35d9
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Nov 7, 2024
* Remove `hook-class-names` from provider.yaml
now that providers>=2.2 there is no need for the hook-class-names any longer.
refrence to apache/airflow#17775

* fix `airflow/provider.yaml.schema.json` and `provider_info.schema.json`

* undo changes in `provider_info.schema.json`

GitOrigin-RevId: 510a6bab4595cce8bd5b1447db957309d70f35d9
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request May 3, 2025
* Remove `hook-class-names` from provider.yaml
now that providers>=2.2 there is no need for the hook-class-names any longer.
refrence to apache/airflow#17775

* fix `airflow/provider.yaml.schema.json` and `provider_info.schema.json`

* undo changes in `provider_info.schema.json`

GitOrigin-RevId: 510a6bab4595cce8bd5b1447db957309d70f35d9
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request May 23, 2025
* Remove `hook-class-names` from provider.yaml
now that providers>=2.2 there is no need for the hook-class-names any longer.
refrence to apache/airflow#17775

* fix `airflow/provider.yaml.schema.json` and `provider_info.schema.json`

* undo changes in `provider_info.schema.json`

GitOrigin-RevId: 510a6bab4595cce8bd5b1447db957309d70f35d9
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:providers full tests needed We need to run full set of tests for this PR to merge provider:cncf-kubernetes Kubernetes (k8s) provider related issues provider:google Google (including GCP) related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants