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.

Sign up for GitHub

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

Jump to bottom

Trim down the PyPI readme #33505

Closed
1 task done
potiuk opened this issue Aug 18, 2023 · 5 comments · Fixed by #33637
Closed
1 task done

Trim down the PyPI readme #33505

potiuk opened this issue Aug 18, 2023 · 5 comments · Fixed by #33637
Assignees
@pankajkoti
Labels
kind:meta High-level information important to the community
Milestone
Airflow 2.7.2

Comments

@potiuk
Copy link
Member

potiuk commented Aug 18, 2023 •
edited
Loading

Body

The PyPI README is far too long for the PyPI page. Just basic summary is needed and links to documentation, changelog,GitHub page.

We have now dedicated Changelog page and there should be a "project-url" pointing to it (same as in Providers).

Some images (AWS) are broken and they should not be there anyway.

Committer

  • I acknowledge that I am a maintainer/committer of the Apache Airflow project.
@potiuk potiuk added the kind:meta High-level information important to the community label Aug 18, 2023
@potiuk potiuk added this to the Airflow 2.7.1 milestone Aug 18, 2023
@pankajkoti
Copy link
Member

I could try working on this if that sounds okay

@potiuk
Copy link
Member Author

potiuk commented Aug 18, 2023

Feel free.

@pankajkoti pankajkoti mentioned this issue Aug 23, 2023
Merged
@uranusjr
Copy link
Member

Just basic summary is needed and links to documentation, changelog, GitHub page.

I don’t think we even need the links? They are already available in the sidebar on the left anyway.

@pankajkoti
Copy link
Member

pankajkoti commented Aug 23, 2023 •
edited
Loading

Just basic summary is needed and links to documentation, changelog, GitHub page.

I don’t think we even need the links? They are already available in the sidebar on the left anyway.

The link to Changelog was added newly here(in the sidebar, yes): https://github.com/apache/airflow/pull/33637/files#diff-fa602a8a75dc9dcc92261bac5f533c2a85e34fcceaff63b3a3a81d9acde2fc52R47

@potiuk
Copy link
Member Author

potiuk commented Aug 23, 2023

don’t think we even need the links? They are already available in the sidebar on the left anyway.

Yep. This is what I meant :)

@ephraimbuddy ephraimbuddy mentioned this issue Sep 4, 2023
Closed
97 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pankajkoti pankajkoti

Labels
kind:meta High-level information important to the community
Projects
None yet
Milestone
Airflow 2.7.2
Development

Successfully merging a pull request may close this issue.

Use a trimmed version of README.md for PyPI astronomer/airflow
4 participants
@potiuk @uranusjr @ephraimbuddy @pankajkoti