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.

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

Links to provider example dags are broken #536

Closed
jmelot opened this issue Jan 7, 2022 · 9 comments · Fixed by apache/airflow#24386
Closed

Links to provider example dags are broken #536

jmelot opened this issue Jan 7, 2022 · 9 comments · Fixed by apache/airflow#24386

Comments

@jmelot
Copy link
Contributor

jmelot commented Jan 7, 2022

The "view source" links in docs/apache_airflow seem fine, for example the example_kubernetes_executor link is ok here:

https://airflow.apache.org/docs/apache-airflow/stable/executor/kubernetes.html

but the "source" links for provider example dags are broken. For example, if you click on the "source" link for example_gcs_to_bigquery here, it directs you to https://airflow.apache.org/docs/apache-airflow-providers-google/stable/_modules/airflow/providers/google/cloud/example_dags/example_gcs_to_bigquery.html which is a 404. The same is true for the example_athena link here.

@potiuk
Copy link
Member

potiuk commented Jan 10, 2022

@mik-laj - any idea ?

@potiuk
Copy link
Member

potiuk commented Jan 23, 2022

Bump?

@mik-laj
Copy link
Member

mik-laj commented Jan 23, 2022

@potiuk
Copy link
Member

potiuk commented Jan 29, 2022

I looked at it, but I have no idea what it has to do with it :(

@mik-laj
Copy link
Member

mik-laj commented Jan 30, 2022

I looked at this problem and checked ExampleLiteral directive and it looks fine. However, the problem may be the use of the sphinx.ext.code module which does not make have a simple way to add a new module page and I can see some tricks are being used to integrate the directive with this extension.
Here are source code of sphinx.ext.code extension.
https://github.com/sphinx-doc/sphinx/blob/08a87d945a8ca7770c589ea878e9b095ed35e6d4/sphinx/ext/viewcode.py

@potiuk
Copy link
Member

potiuk commented Feb 26, 2022

I think we can fix it when we are going to move example dags @mnojek -while implementing https://cwiki.apache.org/confluence/display/AIRFLOW/AIP-47+New+design+of+Airflow+System+Tests ?

@bhirsz
Copy link

bhirsz commented May 5, 2022

In linked issue there is similiar problem. All links to source code are dead. Hovewer we can probably track the origin - for example those links are dead:

https://airflow.apache.org/docs/apache-airflow/2.3.0/_modules/airflow/example_dags/example_external_task_marker_dag.html

https://airflow.apache.org/docs/apache-airflow/stable/_modules/airflow/example_dags/example_external_task_marker_dag.html

But this one works:
https://airflow.apache.org/docs/apache-airflow/2.2.3/_modules/airflow/example_dags/example_external_task_marker_dag.html

Something between Airflow 2.2.3 and 2.3.0 caused this issue (for this particular link. We could have dead links for longer period of time).

On side note it would be worth to add very simple ui tests - just parse all links on the site and check if any is 404.

@bhirsz
Copy link

bhirsz commented May 5, 2022

It can be used to test links:
https://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinx.builders.linkcheck.CheckExternalLinksBuilder

I can try to do it but only after next few days.

potiuk added a commit to potiuk/airflow that referenced this issue Jun 13, 2022
The links to example sources in exampleinclude have been broken in a
number of providers and they were additionally broken by AIP-47.

This PR fixes it.

Fixes: apache#23632
Fixes: apache/airflow-site#536
potiuk added a commit to apache/airflow that referenced this issue Jun 13, 2022
The links to example sources in exampleinclude have been broken in a
number of providers and they were additionally broken by AIP-47.

This PR fixes it.

Fixes: #23632
Fixes: apache/airflow-site#536
@potiuk
Copy link
Member

potiuk commented Jun 24, 2022

This is all fixed now.

potiuk added a commit to potiuk/airflow that referenced this issue Jun 29, 2022
The links to example sources in exampleinclude have been broken in a
number of providers and they were additionally broken by AIP-47.

This PR fixes it.

Fixes: apache#23632
Fixes: apache/airflow-site#536
(cherry picked from commit 08b675c)
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Oct 4, 2022
The links to example sources in exampleinclude have been broken in a
number of providers and they were additionally broken by AIP-47.

This PR fixes it.

Fixes: #23632
Fixes: apache/airflow-site#536
(cherry picked from commit 08b675cf6642171cb1c5ddfb09607b541db70b29)
GitOrigin-RevId: 0d0f57f3bd9e8022c71fb957bfdb60cd052d5cec
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Dec 7, 2022
The links to example sources in exampleinclude have been broken in a
number of providers and they were additionally broken by AIP-47.

This PR fixes it.

Fixes: #23632
Fixes: apache/airflow-site#536
(cherry picked from commit 08b675cf6642171cb1c5ddfb09607b541db70b29)
GitOrigin-RevId: 0d0f57f3bd9e8022c71fb957bfdb60cd052d5cec
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Jan 27, 2023
The links to example sources in exampleinclude have been broken in a
number of providers and they were additionally broken by AIP-47.

This PR fixes it.

Fixes: #23632
Fixes: apache/airflow-site#536
GitOrigin-RevId: 08b675cf6642171cb1c5ddfb09607b541db70b29
kosteev pushed a commit to kosteev/composer-airflow-test-copybara that referenced this issue Sep 12, 2024
The links to example sources in exampleinclude have been broken in a
number of providers and they were additionally broken by AIP-47.

This PR fixes it.

Fixes: #23632
Fixes: apache/airflow-site#536
(cherry picked from commit 08b675cf6642171cb1c5ddfb09607b541db70b29)
GitOrigin-RevId: 0d0f57f3bd9e8022c71fb957bfdb60cd052d5cec
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Sep 18, 2024
The links to example sources in exampleinclude have been broken in a
number of providers and they were additionally broken by AIP-47.

This PR fixes it.

Fixes: #23632
Fixes: apache/airflow-site#536
GitOrigin-RevId: 08b675cf6642171cb1c5ddfb09607b541db70b29
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Nov 7, 2024
The links to example sources in exampleinclude have been broken in a
number of providers and they were additionally broken by AIP-47.

This PR fixes it.

Fixes: #23632
Fixes: apache/airflow-site#536
GitOrigin-RevId: 08b675cf6642171cb1c5ddfb09607b541db70b29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants