Skip to content

Add doc_md attribute to task groups #65679

@joelsewhere

Description

@joelsewhere

Description

I propose adding a doc_md attribute to task groups that renders the documentation in the details sections for the group. The task group details section is pretty lacking in information right now, and high level documentation for the group would go a long way.

Use case/motivation

I have non technical stakeholders who are interested in understanding dags at a high level, and task groups work great for generating a dag visualization that can behave as user friendly documentation. I would like to provide written summaries to stakeholders about each operation, but am only able to do this at the task level. The task level is too detailed for non technical stakeholders, and requires drilling down into the task group, which can easily overwhelm users who're unfamiliar with data engineering terminology/operations.

Related issues

No response

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:UIRelated to UI/UX. For Frontend Developers.kind:featureFeature Requestsneeds-triagelabel for new issues that we didn't triage yet

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions