You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "Kaxil Naik (JIRA)" <ji...@apache.org> on 2019/01/14 11:14:00 UTC
[jira] [Comment Edited] (AIRFLOW-3656) Airflow Web UI link to the
docs should be dynamic to Airflow version
[ https://issues.apache.org/jira/browse/AIRFLOW-3656?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16741947#comment-16741947 ]
Kaxil Naik edited comment on AIRFLOW-3656 at 1/14/19 11:13 AM:
---------------------------------------------------------------
The idea is good. I still prefer RTD any day for documentation (as it supports multi-versioning be default) and makes document management easy - it is like CI/CD for docs. On airflow.apache.org we should just have a static site like https://libcloud.apache.org/ and then have a link on that page for Documentation (similar to apache libcloud) that takes to Readthedocs. I would want to remove the documents entirely on airflow.apache.org.
Uploading multiple version on airflow.apache.org is not as easy as it seems. The only plugin out there sphinx-contrib-versioning that provides multiple versions is no longer mantainted and broke.
+ there should be no need of manual doc creation (which needs all the airflow + extras dependency) and upload.
was (Author: kaxilnaik):
The idea is good. I still prefer RTD any day for documentation (as it supports multi-versioning be default) and makes document management easy - it is like CI/CD for docs. On airflow.apache.org we should just have a static site like https://libcloud.apache.org/ and then have a link on that page for Documentation (similar to apache libcloud) that takes to Readthedocs. I would want to remove the documents entirely on airflow.apache.org.
> Airflow Web UI link to the docs should be dynamic to Airflow version
> --------------------------------------------------------------------
>
> Key: AIRFLOW-3656
> URL: https://issues.apache.org/jira/browse/AIRFLOW-3656
> Project: Apache Airflow
> Issue Type: Task
> Components: ui
> Affects Versions: 1.10.1
> Reporter: jack
> Priority: Major
>
> Currently in the UI Docs->Documentation directs to [https://airflow.incubator.apache.org/]
> # This should be changed to [https://airflow.readthedocs.io/en/stable/] because in readthedocs the user can actually select the docs version. while the current one refers only to Master branch and the user can't change it nor would even know it.
> # Preferably by clicking on the Docs->Documentation it will pick up the Airflow version and point directly to the user Airflow version. Meaning that if the user runs Airflow 1.10.0 it will point to [https://airflow.readthedocs.io/en/1.10.0/] The airflow version is already transparent in the UI (About->Version) so it shouldn't be difficult to build this link.
>
> Previous PR that was related to the doc link is (by [~kaxilnaik]):
> https://github.com/apache/airflow/pull/3050
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)