UI bug with `DAG Docs` display in `DAG Run` Triggering page
Apache Airflow version
2.9.1
If "Other Airflow 2 version" selected, which one?
No response
What happened?
When triggering a DAG Run of a DAG that includes Parameters, in the DAG Run "triggering page" the DAG Docs are expanded by default and clicking on the DAG Docs quickly closes and re-expands the DAG Docs. See gif:
What you think should happen instead?
When triggering a DAG Run of a DAG that includes Parameters, in the DAG Run "triggering page" the DAG Docs should be closed by default and only then should clicking on the DAG Docs expands the docs.
How to reproduce
- Trigger a
DAG Runof aDAGthat includesParameters. - Confirm that the
DAG Docsare already expanded - Click on the
DAG Docsa single time to confirm that theDAG Docswill quickly close and re-expand.
Operating System
Windows 11 WSL2
Versions of Apache Airflow Providers
No response
Deployment
Docker-Compose
Deployment details
No response
Anything else?
No response
Are you willing to submit PR?
- [ ] Yes I am willing to submit a PR!
Code of Conduct
- [X] I agree to follow this project's Code of Conduct
Actually - this was made by me "by intent". I believe the community never "voted" on it but it was assuming:
- DAG docs give guidance for the user how to use the DAG. It might describe guidance when and how to trigger and a general overview about what it does.
- If a manual trigger is being made, the docs are mostly helpful for first time users.
Before changing the behavior back and hiding the docs by default: Can you give a reason why you think this is a problem? If so, can we maybe make a vote about who things displaying DAG docs is benefitial and who does not like to see it? It might be also something that might be a configuration option if there is not a clear result.
I would see it also the way: If docs are bothering you, have you considered not adding them to the DAG? There is no requirement to add documentation. But if there is documentation and it is hidden by default, then users might miss it per default.
@jscheffl In the scenario where it is intended to show the docs by default, there is still a bug. As seen on the GIF when I try to minimize the docs (the first time after opening the page) it quickly collpases and re-expands, forcing you to click it twice in order to minimize it.
Can you give a reason why you think this is a problem?
- I would prefer consistency, since DAG Docs are already collapsed by default in the DAG view.
- I don't need to read the docs by default everytime I want to trigger a DAG manually.
- I prefer to read the docs optionally, specially when dealing with alot of manual DAG run triggers.
If so, can we maybe make a vote
Sure.
It might be also something that might be a configuration option if there is not a clear result.
This would be great.
@jscheffl In the scenario where it is intended to show the docs by default, there is still a bug. As seen on the GIF when I try to minimize the docs (the first time after opening the page) it quickly collapses and re-expands, forcing you to click it twice in order to minimize it.
Okay, agree in this point - to fold the DAG docs you should only need to click once, seems the handler on the folding has a wrong state.