The GitHub Actions job "Tests" on airflow.git has succeeded.
Run started by GitHub user potiuk (triggered by potiuk).

Head commit for run:
d124d3fccb0ab9be8839a98ae9f604bca98d04d2 / Jarek Potiuk <[email protected]>
Improve provider documentation and README structure

The changelong in provider docs has been part of the README which
became part of the page displayed in `PyPI` as well as the main
page displayed when you want to see provider documentation. This
was fine when the changelog was short, but with providers history
growing, the main page became longer and longer and the generated
index on the right side (from the changelog) became less and less
usable, and changelog itself became far less discoverable.

This change introduces another approach. Changelog gets its
own, separate page and it has quite a few positive consequences:

1) we can add separate "Changelog" URL in PyPI so that it is
   prominently visible at the TOC in PyPI URLS
2) we can link to the changelog easily from stable page - without
   worrrying which version we link to
3) the README file is part of the package so fixing the changelog
   in case of a doc-only mistake will not fix the PyPI page (it
   will only be fixed in future releases)
4) the link tree on the right side of the provider index page becomes back
   usable
5) the left-side TOD  on the provider's index page containes two
   prominent links that were missing: Home (back to the index provider
   page), Changelog, and Security - all under "Basics" link
6) The TOC is not repeated in the index page itself, making the content
   immediately visible rather than having to scroll trough the long
   TOC (in some cases like amazon the TOC was reallly long).

Report URL: https://github.com/apache/airflow/actions/runs/5371882576

With regards,
GitHub Actions via GitBox


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to