Ondrej Kokes created AIRFLOW-1747:
-------------------------------------
Summary: Incorrect documentation
Key: AIRFLOW-1747
URL: https://issues.apache.org/jira/browse/AIRFLOW-1747
Project: Apache Airflow
Issue Type: Improvement
Components: Documentation
Reporter: Ondrej Kokes
Given that the PyPI package is now apache-airflow, not just airflow (as fixed
in JIRAs 1185 and 1187), this needs to be reflected in the documentation. The
rst code has been fixed, but the generated documentation is stale. *It's still
telling people to install {{airflow}}, not {{apache-airflow}}.*
* [The original documentation|https://airflow.apache.org/installation.html]
still instructs people to use {{pip install airflow}}
* So does the [pythonhosted.org
version|http://pythonhosted.org/airflow/installation.html] - this one is linked
to from README.md in the projects, so I guess it's the most visible piece of
documentation ("Please visit the Airflow Platform documentation for help with
installing Airflow, getting a quick start, or a more complete tutorial.")
* ReadTheDocs is fine
Pythonhosted seems to depend on what's set up on PyPI, so that one depends on
what repo the documentation is taken from. As the project was renamed, I guess
the documentation is still taken from the old code.
As for the official website... I don't know how that's generated, but it could
do with a refresh.
Let me know if I can help in any way - I unfortunately don't know much about
how these are setup.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
