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 2021/04/29 12:28:26 UTC

[GitHub] [airflow] JavierLopezT opened a new issue #15590: Documentation for Configuration JSON when triggering a DAG manually

JavierLopezT opened a new issue #15590:
URL: https://github.com/apache/airflow/issues/15590


   When you click on 'Trigger Dag', you are redirected to a section in which you can introduce a configuration JSON, and you see a message like this:
   
   `To access configuration in your DAG use {{ dag_run.conf }}.`
   
   It would be very cool to be able to write your own documentation, so that you can explain how to use the dag_run.conf variables of that dag. 


-- 
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] eladkal commented on issue #15590: Documentation for Configuration JSON when triggering a DAG manually

Posted by GitBox <gi...@apache.org>.
eladkal commented on issue #15590:
URL: https://github.com/apache/airflow/issues/15590#issuecomment-975486397


   @JavierLopezT can you please provide example of what you expect from this feature and why #13365 isn't covering it?


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] JavierLopezT edited a comment on issue #15590: Documentation for Configuration JSON when triggering a DAG manually

Posted by GitBox <gi...@apache.org>.
JavierLopezT edited a comment on issue #15590:
URL: https://github.com/apache/airflow/issues/15590#issuecomment-829418518


   > #13365
   > Is it related?
   
   Indeed. However, it seems that it would render the entire documentation of the dag, isn't it? What I propose is a separate doc (dunno if that would be desirable though)


-- 
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] JavierLopezT edited a comment on issue #15590: Documentation for Configuration JSON when triggering a DAG manually

Posted by GitBox <gi...@apache.org>.
JavierLopezT edited a comment on issue #15590:
URL: https://github.com/apache/airflow/issues/15590#issuecomment-829418518


   > #13365
   > Is it related?
   
   Indeed, thanks. However, it seems that it would render the entire documentation of the dag, isn't it? What I propose is a separate doc (dunno if that would be desirable though)


-- 
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] JavierLopezT commented on issue #15590: Documentation for Configuration JSON when triggering a DAG manually

Posted by GitBox <gi...@apache.org>.
JavierLopezT commented on issue #15590:
URL: https://github.com/apache/airflow/issues/15590#issuecomment-977664374


   > @JavierLopezT can you please provide example of what you expect from this feature and why #13365 isn't covering it?
   
   It is basically what I said in https://github.com/apache/airflow/issues/15590#issuecomment-829418518 If my assumption that #13365 will render the entire documentation of the DAG in that screen is correct, then I think what I propose could be more optimal in some cases. Let's say I have the following DAG doc:
   
   ```
   """This DAG blabla blablaba
    + 100 lines of documentation
   
   When you trigger manually the DAG, the parameters blabla"""
   ```
   
   I don't want to see 103 lines on the screen of JSON configuration. Instead, I just want to see the last line, which I will assign to the attribute `dag.doc_json_configuration` or something like that, instead of the attribute `dag.doc_md`
   


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] JavierLopezT edited a comment on issue #15590: Documentation for Configuration JSON when triggering a DAG manually

Posted by GitBox <gi...@apache.org>.
JavierLopezT edited a comment on issue #15590:
URL: https://github.com/apache/airflow/issues/15590#issuecomment-977664374


   > @JavierLopezT can you please provide example of what you expect from this feature and why #13365 isn't covering it?
   
   It is basically what I said in https://github.com/apache/airflow/issues/15590#issuecomment-829418518 If my assumption that #13365 will render the entire documentation of the DAG in that screen is correct, then I think what I propose could be more optimal in some cases. Let's say I have the following DAG doc:
   
   ```
   """This DAG blabla blablaba
    + 100 lines of documentation
   
   When you trigger manually the DAG, the parameters blabla"""
   ```
   
   I don't want to see 103 lines on the screen of JSON configuration. Instead, I just want to see the last line, which I will assign to the attribute `dag.doc_json_configuration` or something like that, instead of the attribute `dag.doc_md`
   
   Maybe I should have created a discussion instead of an issue. I am sorry


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] JavierLopezT commented on issue #15590: Documentation for Configuration JSON when triggering a DAG manually

Posted by GitBox <gi...@apache.org>.
JavierLopezT commented on issue #15590:
URL: https://github.com/apache/airflow/issues/15590#issuecomment-829418518


   > #13365
   > Is it related?
   
   Indeed, it seems to be what I want. However, I think there isn't any documentation, is it?


-- 
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 #15590: Documentation for Configuration JSON when triggering a DAG manually

Posted by GitBox <gi...@apache.org>.
mik-laj commented on issue #15590:
URL: https://github.com/apache/airflow/issues/15590#issuecomment-829323829


   https://github.com/apache/airflow/pull/13365
   Is it related?


-- 
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] JavierLopezT commented on issue #15590: Specific documentation for Configuration JSON when triggering a DAG manually

Posted by GitBox <gi...@apache.org>.
JavierLopezT commented on issue #15590:
URL: https://github.com/apache/airflow/issues/15590#issuecomment-1001012686


   comment for removing stale


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] github-actions[bot] commented on issue #15590: Specific documentation for Configuration JSON when triggering a DAG manually

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on issue #15590:
URL: https://github.com/apache/airflow/issues/15590#issuecomment-1000949537


   This issue has been automatically marked as stale because it has been open for 30 days with no response from the author. It will be closed in next 7 days if no further activity occurs from the issue author.


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org