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

Broken Source Code Links in Operator Guides #23632

Closed
2 tasks done
SamWheating opened this issue May 11, 2022 · 10 comments · Fixed by #24386 or apache/airflow-site#613
Closed
2 tasks done

Broken Source Code Links in Operator Guides #23632

SamWheating opened this issue May 11, 2022 · 10 comments · Fixed by #24386 or apache/airflow-site#613
Labels
kind:bug This is a clearly a bug kind:documentation

Comments

@SamWheating
Copy link
Contributor

SamWheating commented May 11, 2022

What do you see as an issue?

The [source] links in the operator HowTo guides seem to be 404'ing:

image

(source)

I tried to fix this but got kinda lost in the docs build system.

Solving the problem

I think that sphinx isn't loading the example_dags folder, as these modules aren't found here:

https://airflow.apache.org/docs/apache-airflow/2.3.0/_modules/

While they were present in 2.2.3:

https://airflow.apache.org/docs/apache-airflow/2.2.3/_modules/

Anything else

I can keep looking into this, but would appreciate any pointers or guidance.

Are you willing to submit PR?

  • Yes I am willing to submit a PR!

Code of Conduct

@SamWheating SamWheating added kind:bug This is a clearly a bug kind:documentation labels May 11, 2022
@SamWheating SamWheating changed the title Source Code Links in Operator Guides are 404'ing Broken Source Code Links in Operator Guides May 11, 2022
@eladkal
Copy link
Contributor

eladkal commented May 11, 2022

see #23480

@potiuk
Copy link
Member

potiuk commented May 11, 2022

Yep. Known issue. Maybe time to fix it.

@vijaya-lakshmi-venkatraman
Copy link

vijaya-lakshmi-venkatraman commented May 18, 2022

Hi
I would like to give a try on this if this is not already taken.
Also, request to provide some pointers

@potiuk
Copy link
Member

potiuk commented May 18, 2022

Feel Free! :) Sphinx is a bit mysterious creature and asks many riddles, so any help is more than welcome.

@potiuk
Copy link
Member

potiuk commented May 18, 2022

Some pointers here: apache/airflow-site#536

@potiuk
Copy link
Member

potiuk commented May 18, 2022

And possibly @mik-laj can help

@vijaya-lakshmi-venkatraman

Thank you.
My understanding from the comment is that between 2.2.3 and the stable (2.3.0) version, the links have stopped working due to some change, possibly in the sphinx.ext.code module.
For the next step, should I be checking how to add a new module to Sphinx?

@potiuk
Copy link
Member

potiuk commented May 19, 2022

I personally do not know :). I have very little knowledge about sphinx. Big part of the task is to find out what to do really because possiblychange in sphinx triggered it but we do not know exactly what was the root cause.

@rbiegacz
Copy link

BTW - the links stopped working also for providers. For example, [source] link doesn't work in the page devoted to this operator: https://airflow.apache.org/docs/apache-airflow-providers-google/stable/operators/cloud/automl.html

@potiuk
Copy link
Member

potiuk commented Jun 11, 2022

Fixes are there:

potiuk added a commit to apache/airflow-site that referenced this issue Jun 12, 2022
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 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 added a commit to apache/airflow-site that referenced this issue Jun 13, 2022
potiuk added a commit to apache/airflow-site that referenced this issue Jun 14, 2022
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)
@vijaya-lakshmi-venkatraman vijaya-lakshmi-venkatraman removed their assignment Sep 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:bug This is a clearly a bug kind:documentation
Projects
None yet
5 participants