Add TaskGroup markdown documentation support#67207
Draft
ytoprakc wants to merge 1 commit into
Draft
Conversation
3091706 to
aff4dea
Compare
aff4dea to
946e941
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds doc_md support for TaskGroups, allowing authors to document a TaskGroup at the same level of abstraction shown in the Dag graph and Grid views.
TaskGroups can now define markdown documentation directly or by referencing a .md file, and that documentation is serialized with the Dag, exposed through the UI structure APIs, and rendered from the TaskGroup details panel.
Changes
Why
TaskGroups are often the right level of abstraction for explaining a Dag to non-technical stakeholders. Before this change, documentation could be attached to a Dag or individual tasks, but not to the TaskGroup that represents a higher-level operation. This lets Dag authors provide concise summaries for grouped operations without requiring users to drill into task-level details.
doc_mdattribute to task groups #65679Testing
Defining a
.mdfilepath fordoc_mdUsing docstrings when
doc_mdis not definedIf both
doc_mdand docstrings are available,doc_mdtakes precedence.Documentation is also available from the Grid View

Was generative AI tooling used to co-author this PR?
Generated-by: Codex following the guidelines