You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2020/08/28 10:38:33 UTC
[GitHub] [airflow] battlesnake opened a new issue #10626: DAG description/documentation visible in UI
battlesnake opened a new issue #10626:
URL: https://github.com/apache/airflow/issues/10626
**Description**
I would like a way to (optionally) provide DAG description text block when creating a DAG, and have this text shown in Airflow UI for tree/graph view, and in the Trigger Dag screen.
**Use case / motivation**
A brief description of the DAG (and possibly, its owner / external dependencies) will be helpful for users, to understand what the DAG is for and who to DAG-specific report issues to.
Given that we can now specify a JSON config for `context.dag_run.conf` via the Trigger Dag prompt, showing documentation there would also help the user to know what they can configure via that field.
**Related Issues**
None that I know of
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] battlesnake commented on issue #10626: DAG description/documentation that's viewable in the UI
Posted by GitBox <gi...@apache.org>.
battlesnake commented on issue #10626:
URL: https://github.com/apache/airflow/issues/10626#issuecomment-682556001
Anything I should take into consideration if I implement this myself and send a PR?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] battlesnake removed a comment on issue #10626: DAG description/documentation that's viewable in the UI
Posted by GitBox <gi...@apache.org>.
battlesnake removed a comment on issue #10626:
URL: https://github.com/apache/airflow/issues/10626#issuecomment-684772983
I've just tried this now and I notice that the description is displayed in one line to the right of the DAG title, and is truncated when it gets long.
I propose two possible solutions for this (which aren't mutually exclusive):
Suggestion 1: Either expand that description text when clicked on, or display it in full in a dialog, or have a separate tab for showing DAG description in full.
Suggestion 2: Have a separate longer description/documentation string that appears in the "Trigger DAG" page, which can give more detailed information, especially regarding the dag_run config.
I'm happy to implement either/both of these myself if they're ok with you.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] battlesnake edited a comment on issue #10626: DAG description/documentation that's viewable in the UI
Posted by GitBox <gi...@apache.org>.
battlesnake edited a comment on issue #10626:
URL: https://github.com/apache/airflow/issues/10626#issuecomment-684772983
I've just tried this now and I notice that the description is displayed in one line to the right of the DAG title, and is truncated when it gets long.
Suggestion 1: Either expand that description text when clicked on, or display it in full in a dialog, or have a separate tab for showing DAG description in full.
Suggestion 2: Would it be ok to have a separate longer description/documentation string that appears in the "Trigger DAG" page, which can give more detailed information, especially regarding the dag_run config?
I'm happy to implement either/both of these myself if they're ok with you.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] battlesnake closed issue #10626: DAG description/documentation that's viewable in the UI
Posted by GitBox <gi...@apache.org>.
battlesnake closed issue #10626:
URL: https://github.com/apache/airflow/issues/10626
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] battlesnake commented on issue #10626: DAG description/documentation that's viewable in the UI
Posted by GitBox <gi...@apache.org>.
battlesnake commented on issue #10626:
URL: https://github.com/apache/airflow/issues/10626#issuecomment-684772983
I've just tried this now and I notice that the description is displayed in one line to the right of the DAG title, and is truncated when it gets long.
Would it be ok to have a separate longer description/documentation string that appears in the "Trigger DAG" page, which can give more detailed information, especially regarding the dag_run config?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] battlesnake closed issue #10626: DAG description/documentation that's viewable in the UI
Posted by GitBox <gi...@apache.org>.
battlesnake closed issue #10626:
URL: https://github.com/apache/airflow/issues/10626
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] battlesnake edited a comment on issue #10626: DAG description/documentation that's viewable in the UI
Posted by GitBox <gi...@apache.org>.
battlesnake edited a comment on issue #10626:
URL: https://github.com/apache/airflow/issues/10626#issuecomment-684772983
I've just tried this now and I notice that the description is displayed in one line to the right of the DAG title, and is truncated when it gets long.
Suggestion 1: Either expand that description text when clicked on, or display it in full in a dialog, or have a separate tab for showing DAG description in full.
Suggestion 2: Have a separate longer description/documentation string that appears in the "Trigger DAG" page, which can give more detailed information, especially regarding the dag_run config?
I'm happy to implement either/both of these myself if they're ok with you.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] mik-laj commented on issue #10626: DAG description/documentation that's viewable in the UI
Posted by GitBox <gi...@apache.org>.
mik-laj commented on issue #10626:
URL: https://github.com/apache/airflow/issues/10626#issuecomment-682700428
Here is docs about DAG.doc: https://airflow.readthedocs.io/en/latest/concepts.html#documentation-notes
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] coopergillan commented on issue #10626: DAG description/documentation that's viewable in the UI
Posted by GitBox <gi...@apache.org>.
coopergillan commented on issue #10626:
URL: https://github.com/apache/airflow/issues/10626#issuecomment-682560852
I thought this was already available either the `dag_description` attribute in the `DAG` object. Is this talking about something else?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] battlesnake commented on issue #10626: DAG description/documentation that's viewable in the UI
Posted by GitBox <gi...@apache.org>.
battlesnake commented on issue #10626:
URL: https://github.com/apache/airflow/issues/10626#issuecomment-683025880
:facepalm: Thanks, some how I've not noticed that previously.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] battlesnake edited a comment on issue #10626: DAG description/documentation that's viewable in the UI
Posted by GitBox <gi...@apache.org>.
battlesnake edited a comment on issue #10626:
URL: https://github.com/apache/airflow/issues/10626#issuecomment-684772983
I've just tried this now and I notice that the description is displayed in one line to the right of the DAG title, and is truncated when it gets long.
I propose two possible solutions for this (which aren't mutually exclusive):
Suggestion 1: Either expand that description text when clicked on, or display it in full in a dialog, or have a separate tab for showing DAG description in full.
Suggestion 2: Have a separate longer description/documentation string that appears in the "Trigger DAG" page, which can give more detailed information, especially regarding the dag_run config.
I'm happy to implement either/both of these myself if they're ok with you.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org