Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Make the providers operators/hooks reference much more usable #17768

Merged
merged 1 commit into from
Aug 21, 2021

Conversation

potiuk
Copy link
Member

@potiuk potiuk commented Aug 21, 2021

The providers operators/hooks reference contained only top-level list of
groups of providers, which make them less-usable than they could be as
the users did not see at this page links to particular operators/hooks,
it was not really visible what is "available" (discoverability) and
the more detailed "Service" and "Transfer" pages are not really
readable enough to give "at a glance" overview what is available.

This change improves that, removes the repeated multiple times
"operators and hooks" which was kind of annoying, and increases
the TOC-level to 3 giving a nice overview of all available and
exposed operator and hooks.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.

The providers operators/hooks reference contained only top-level list of
groups of providers, which make them less-usable than they could be as
the users did not see at this page links to particular operators/hooks,
it was not really visible what is "available" (discoverability) and
the more detailed "Service" and "Transfer" pages are not really
readable enough to give "at a glance" overview what is available.

This change improves that, removes the repeated multiple times
"operators and hooks" which was kind of annoying, and increases
the TOC-level to 3 giving a nice overview of all available and
exposed operator and hooks.
@potiuk
Copy link
Member Author

potiuk commented Aug 21, 2021

I have a feeling that what I propose is WAY more usable:

Compare this (old one):

Screenshot 2021-08-21 13 00 34

With this (new one):

Screenshot 2021-08-21 13 00 02

@kaxil kaxil changed the title make the providers operators/hooks reference much more usable Make the providers operators/hooks reference much more usable Aug 21, 2021
@kaxil kaxil changed the title Make the providers operators/hooks reference much more usable Docs: Make the providers operators/hooks reference much more usable Aug 21, 2021
@github-actions github-actions bot added the okay to merge It's ok to merge this PR as it does not require more tests label Aug 21, 2021
@github-actions
Copy link

The PR is likely ready to be merged. No tests are needed as no important environment files, nor python files were modified by it. However, committers might decide that full test matrix is needed and add the 'full tests needed' label. Then you should rebase it to the latest main or amend the last commit of the PR, and push it with --force-with-lease.

@potiuk potiuk merged commit c7f37a9 into apache:main Aug 21, 2021
@potiuk potiuk deleted the improve-providers-list-usability branch August 21, 2021 17:47
potiuk added a commit that referenced this pull request Aug 28, 2021
The providers operators/hooks reference contained only top-level list of
groups of providers, which make them less-usable than they could be as
the users did not see at this page links to particular operators/hooks,
it was not really visible what is "available" (discoverability) and
the more detailed "Service" and "Transfer" pages are not really
readable enough to give "at a glance" overview what is available.

This change improves that, removes the repeated multiple times
"operators and hooks" which was kind of annoying, and increases
the TOC-level to 3 giving a nice overview of all available and
exposed operator and hooks.

(cherry picked from commit c7f37a9)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:documentation okay to merge It's ok to merge this PR as it does not require more tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants