potiuk commented on code in PR #50179: URL: https://github.com/apache/airflow/pull/50179#discussion_r2077333337
########## README.md: ########## @@ -139,54 +139,10 @@ Documentation for dependent projects like provider distributions, Docker image, <!-- END Getting started, please keep comment here to allow auto update of PyPI readme.md --> <!-- START Installing from PyPI, please keep comment here to allow auto update of PyPI readme.md --> -## Installing from PyPI -We publish Apache Airflow as `apache-airflow` package in PyPI. Installing it however might be sometimes tricky -because Airflow is a bit of both a library and application. Libraries usually keep their dependencies open, and -applications usually pin them, but we should do neither and both simultaneously. We decided to keep -our dependencies as open as possible (in `pyproject.toml`) so users can install different versions of libraries -if needed. This means that `pip install apache-airflow` will not work from time to time or will -produce unusable Airflow installation. +## Installation Guide Review Comment: i also think there is one more thing needed here. As you can see (see the comments above) part of the README is copied over to `generated/PYPI _README.md` - which is then used to generate Python packages. This is done by a pre-commit (you will see it failing in static checks). And the problem is - if we change it to link here, that generated PYPI readme is not going to have INSTALLING.md to link to - so the README generated in `generated` should have no links whatsoever other than `https://` links maybe directly to some external docs. But really what happens here, is that this whole "installation" section is not needed at all in `PyPI` readme, because the basic installation is described at the top with `pip install` command and there is also link to docuemntation as part of PyPI links. So I think the pre-commit should be updated to not copy the whole installation chapter to the `PYPI_README.md` -- 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]
