Skip to content

docs: add docs for custom alert messages #50273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 8, 2025

Conversation

kevinhongzl
Copy link
Contributor

closes: #50193
related: #48450

Why

This PR adds docs for custom alert messages on the dashboard.

What

I documented this feature based on my understanding that:

  1. The argument categeory in UIAlert is now required.
  2. Alert messages now support Markdown (but not HTML and Markup anymore, therefore I did not mention them)

^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in airflow-core/newsfragments.

@kevinhongzl kevinhongzl force-pushed the add-docs-for-custom-ui-alerts branch 2 times, most recently from 0275f7b to 954a8f1 Compare May 7, 2025 00:46
@eladkal eladkal added this to the Airflow 3.0.2 milestone May 7, 2025
@eladkal eladkal added the type:doc-only Changelog: Doc Only label May 7, 2025
@kevinhongzl kevinhongzl force-pushed the add-docs-for-custom-ui-alerts branch 2 times, most recently from fc61abb to 467148b Compare May 7, 2025 07:35
@kevinhongzl kevinhongzl force-pushed the add-docs-for-custom-ui-alerts branch from 438045b to 750608e Compare May 7, 2025 16:27
@eladkal eladkal merged commit 8583fba into apache:main May 8, 2025
51 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs for custom UI alerts
2 participants