You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@airflow.apache.org by Shah Altaf <me...@gmail.com> on 2017/06/04 19:13:19 UTC
DAG description parameter
Hi all,
Over time a DAG list can grow and it would be useful to have a description
next to the DAGs. I spotted a description parameter in the DAG definition
https://airflow.incubator.apache.org/code.html#airflow.models.DAG
- *description* (*string*) – The description for the DAG to e.g. be
shown on the webserver
But I can't find where this is shown. Is there a way to have it appear on
the main DAG list page?
Apologies if this has been answered already, my google-fu picked up
nothing.
Re: DAG description parameter
Posted by Maxime Beauchemin <ma...@gmail.com>.
It should be in v1.7.1.3.
Max
On Thu, Jun 15, 2017 at 2:51 PM, manish ranjan <cs...@gmail.com>
wrote:
> Is this available on v1.7.1.3? Or is it only available in later versions?
>
> Manish
>
> ~Manish
>
>
>
> On Sun, Jun 4, 2017 at 12:23 PM, Shah Altaf <me...@gmail.com> wrote:
>
> > It is a long standing tradition to spend hours searching for something,
> and
> > then to find the answer moments after posting to a forum/mailinglist.
> >
> > Thanks @Amit, I also spotted it as a tooltip on the DAG title.
> >
> >
> >
> > On Sun, Jun 4, 2017 at 8:18 PM Amit Pahwa <am...@amitpahwa.com> wrote:
> >
> > > Next to the DAG id/name*
> > >
> > > On Jun 4, 2017 12:18 PM, "Amit Pahwa" <am...@amitpahwa.com> wrote:
> > >
> > > > It shows up next to the DAG when you click into the DAG.
> > > >
> > > > On Jun 4, 2017 12:13 PM, "Shah Altaf" <me...@gmail.com> wrote:
> > > >
> > > >> Hi all,
> > > >>
> > > >> Over time a DAG list can grow and it would be useful to have a
> > > description
> > > >> next to the DAGs. I spotted a description parameter in the DAG
> > > definition
> > > >>
> > > >> https://airflow.incubator.apache.org/code.html#airflow.models.DAG
> > > >>
> > > >>
> > > >> - *description* (*string*) – The description for the DAG to e.g.
> be
> > > >> shown on the webserver
> > > >>
> > > >> But I can't find where this is shown. Is there a way to have it
> > appear
> > > on
> > > >> the main DAG list page?
> > > >>
> > > >> Apologies if this has been answered already, my google-fu picked up
> > > >> nothing.
> > > >>
> > > >
> > >
> >
>
Re: DAG description parameter
Posted by manish ranjan <cs...@gmail.com>.
Is this available on v1.7.1.3? Or is it only available in later versions?
Manish
~Manish
On Sun, Jun 4, 2017 at 12:23 PM, Shah Altaf <me...@gmail.com> wrote:
> It is a long standing tradition to spend hours searching for something, and
> then to find the answer moments after posting to a forum/mailinglist.
>
> Thanks @Amit, I also spotted it as a tooltip on the DAG title.
>
>
>
> On Sun, Jun 4, 2017 at 8:18 PM Amit Pahwa <am...@amitpahwa.com> wrote:
>
> > Next to the DAG id/name*
> >
> > On Jun 4, 2017 12:18 PM, "Amit Pahwa" <am...@amitpahwa.com> wrote:
> >
> > > It shows up next to the DAG when you click into the DAG.
> > >
> > > On Jun 4, 2017 12:13 PM, "Shah Altaf" <me...@gmail.com> wrote:
> > >
> > >> Hi all,
> > >>
> > >> Over time a DAG list can grow and it would be useful to have a
> > description
> > >> next to the DAGs. I spotted a description parameter in the DAG
> > definition
> > >>
> > >> https://airflow.incubator.apache.org/code.html#airflow.models.DAG
> > >>
> > >>
> > >> - *description* (*string*) – The description for the DAG to e.g. be
> > >> shown on the webserver
> > >>
> > >> But I can't find where this is shown. Is there a way to have it
> appear
> > on
> > >> the main DAG list page?
> > >>
> > >> Apologies if this has been answered already, my google-fu picked up
> > >> nothing.
> > >>
> > >
> >
>
Re: DAG description parameter
Posted by Marc Bollinger <ma...@lumoslabs.com>.
We somehow just noticed this a few weeks ago when pondering how best to get
more documentation into our DAGs, and just started using the heck out of it.
On Sunday, June 4, 2017, Maxime Beauchemin <ma...@gmail.com>
wrote:
> Also note this feature:
> https://airflow.apache.org/concepts.html#documentation-notes
>
> Specifically the `doc_md` attribute. It applies to tasks and DAGs.
>
> Max
>
> On Sun, Jun 4, 2017 at 12:23 PM, Shah Altaf <mendhak@gmail.com
> <javascript:;>> wrote:
>
> > It is a long standing tradition to spend hours searching for something,
> and
> > then to find the answer moments after posting to a forum/mailinglist.
> >
> > Thanks @Amit, I also spotted it as a tooltip on the DAG title.
> >
> >
> >
> > On Sun, Jun 4, 2017 at 8:18 PM Amit Pahwa <amit@amitpahwa.com
> <javascript:;>> wrote:
> >
> > > Next to the DAG id/name*
> > >
> > > On Jun 4, 2017 12:18 PM, "Amit Pahwa" <amit@amitpahwa.com
> <javascript:;>> wrote:
> > >
> > > > It shows up next to the DAG when you click into the DAG.
> > > >
> > > > On Jun 4, 2017 12:13 PM, "Shah Altaf" <mendhak@gmail.com
> <javascript:;>> wrote:
> > > >
> > > >> Hi all,
> > > >>
> > > >> Over time a DAG list can grow and it would be useful to have a
> > > description
> > > >> next to the DAGs. I spotted a description parameter in the DAG
> > > definition
> > > >>
> > > >> https://airflow.incubator.apache.org/code.html#airflow.models.DAG
> > > >>
> > > >>
> > > >> - *description* (*string*) – The description for the DAG to e.g.
> be
> > > >> shown on the webserver
> > > >>
> > > >> But I can't find where this is shown. Is there a way to have it
> > appear
> > > on
> > > >> the main DAG list page?
> > > >>
> > > >> Apologies if this has been answered already, my google-fu picked up
> > > >> nothing.
> > > >>
> > > >
> > >
> >
>
Re: DAG description parameter
Posted by Maxime Beauchemin <ma...@gmail.com>.
Also note this feature:
https://airflow.apache.org/concepts.html#documentation-notes
Specifically the `doc_md` attribute. It applies to tasks and DAGs.
Max
On Sun, Jun 4, 2017 at 12:23 PM, Shah Altaf <me...@gmail.com> wrote:
> It is a long standing tradition to spend hours searching for something, and
> then to find the answer moments after posting to a forum/mailinglist.
>
> Thanks @Amit, I also spotted it as a tooltip on the DAG title.
>
>
>
> On Sun, Jun 4, 2017 at 8:18 PM Amit Pahwa <am...@amitpahwa.com> wrote:
>
> > Next to the DAG id/name*
> >
> > On Jun 4, 2017 12:18 PM, "Amit Pahwa" <am...@amitpahwa.com> wrote:
> >
> > > It shows up next to the DAG when you click into the DAG.
> > >
> > > On Jun 4, 2017 12:13 PM, "Shah Altaf" <me...@gmail.com> wrote:
> > >
> > >> Hi all,
> > >>
> > >> Over time a DAG list can grow and it would be useful to have a
> > description
> > >> next to the DAGs. I spotted a description parameter in the DAG
> > definition
> > >>
> > >> https://airflow.incubator.apache.org/code.html#airflow.models.DAG
> > >>
> > >>
> > >> - *description* (*string*) – The description for the DAG to e.g. be
> > >> shown on the webserver
> > >>
> > >> But I can't find where this is shown. Is there a way to have it
> appear
> > on
> > >> the main DAG list page?
> > >>
> > >> Apologies if this has been answered already, my google-fu picked up
> > >> nothing.
> > >>
> > >
> >
>
Re: DAG description parameter
Posted by Shah Altaf <me...@gmail.com>.
It is a long standing tradition to spend hours searching for something, and
then to find the answer moments after posting to a forum/mailinglist.
Thanks @Amit, I also spotted it as a tooltip on the DAG title.
On Sun, Jun 4, 2017 at 8:18 PM Amit Pahwa <am...@amitpahwa.com> wrote:
> Next to the DAG id/name*
>
> On Jun 4, 2017 12:18 PM, "Amit Pahwa" <am...@amitpahwa.com> wrote:
>
> > It shows up next to the DAG when you click into the DAG.
> >
> > On Jun 4, 2017 12:13 PM, "Shah Altaf" <me...@gmail.com> wrote:
> >
> >> Hi all,
> >>
> >> Over time a DAG list can grow and it would be useful to have a
> description
> >> next to the DAGs. I spotted a description parameter in the DAG
> definition
> >>
> >> https://airflow.incubator.apache.org/code.html#airflow.models.DAG
> >>
> >>
> >> - *description* (*string*) – The description for the DAG to e.g. be
> >> shown on the webserver
> >>
> >> But I can't find where this is shown. Is there a way to have it appear
> on
> >> the main DAG list page?
> >>
> >> Apologies if this has been answered already, my google-fu picked up
> >> nothing.
> >>
> >
>
Re: DAG description parameter
Posted by Amit Pahwa <am...@amitpahwa.com>.
Next to the DAG id/name*
On Jun 4, 2017 12:18 PM, "Amit Pahwa" <am...@amitpahwa.com> wrote:
> It shows up next to the DAG when you click into the DAG.
>
> On Jun 4, 2017 12:13 PM, "Shah Altaf" <me...@gmail.com> wrote:
>
>> Hi all,
>>
>> Over time a DAG list can grow and it would be useful to have a description
>> next to the DAGs. I spotted a description parameter in the DAG definition
>>
>> https://airflow.incubator.apache.org/code.html#airflow.models.DAG
>>
>>
>> - *description* (*string*) – The description for the DAG to e.g. be
>> shown on the webserver
>>
>> But I can't find where this is shown. Is there a way to have it appear on
>> the main DAG list page?
>>
>> Apologies if this has been answered already, my google-fu picked up
>> nothing.
>>
>
Re: DAG description parameter
Posted by Amit Pahwa <am...@amitpahwa.com>.
It shows up next to the DAG when you click into the DAG.
On Jun 4, 2017 12:13 PM, "Shah Altaf" <me...@gmail.com> wrote:
> Hi all,
>
> Over time a DAG list can grow and it would be useful to have a description
> next to the DAGs. I spotted a description parameter in the DAG definition
>
> https://airflow.incubator.apache.org/code.html#airflow.models.DAG
>
>
> - *description* (*string*) – The description for the DAG to e.g. be
> shown on the webserver
>
> But I can't find where this is shown. Is there a way to have it appear on
> the main DAG list page?
>
> Apologies if this has been answered already, my google-fu picked up
> nothing.
>