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

Remove reference to undead tasks from documentation #43536

Merged
merged 14 commits into from
Jan 26, 2025

Conversation

karenbraganz
Copy link
Collaborator

This PR removes references to undead tasks from the docs page here.

The term "undead task" is not used in the logs. Instead, if a running task has its state externally changed (what undead tasks is referring to in the docs), the logs display the below message where "x" is the new task state (source code).

"State of this instance has been externally set to <x>. Terminating instance."

There is no reference to undead tasks within this log message or anywhere else in Airflow (I think). Therefore, users do not search for the term "undead tasks" when they encounter this error. Including it in the documentation seems unhelpful and can even be confusing if users conflate it with zombie tasks.

Additionally, the line in the documentation above the code snippet states: "Below is the code snippet from the Airflow scheduler that runs periodically to detect zombie/undead tasks." This line is incorrect because the snippet only contains code for detecting zombies. The code to detect tasks whose state has been changed externally is in local_task_job_runner.py.


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

@karenbraganz
Copy link
Collaborator Author

karenbraganz commented Nov 4, 2024

I have removed the code snippet.
zombie_docs

Copy link

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the stale Stale PRs per the .github/workflows/stale.yml policy file label Dec 20, 2024
@github-actions github-actions bot removed the stale Stale PRs per the .github/workflows/stale.yml policy file label Dec 23, 2024
@karenbraganz
Copy link
Collaborator Author

karenbraganz commented Jan 10, 2025

@RNHTTR as discussed offline, the URL redirects were failing in my tests because redirecting sections doesn't work on Sphinx by only modifying redirects.txt.

Therefore, I created redirects.js to dynamically handle URL fragment redirects. I built the docs and tested this out to confirm that it works.

@RNHTTR
Copy link
Contributor

RNHTTR commented Jan 15, 2025

Any opposition to this @potiuk ?

@potiuk potiuk merged commit 88a8eff into apache:main Jan 26, 2025
46 checks passed
vatsrahul1001 pushed a commit to astronomer/airflow that referenced this pull request Jan 27, 2025
@utkarsharma2 utkarsharma2 added the type:doc-only Changelog: Doc Only label Jan 27, 2025
got686-yandex pushed a commit to got686-yandex/airflow that referenced this pull request Jan 30, 2025
niklasr22 pushed a commit to niklasr22/airflow that referenced this pull request Feb 8, 2025
ambika-garg pushed a commit to ambika-garg/airflow that referenced this pull request Feb 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants