-
Notifications
You must be signed in to change notification settings - Fork 51
docs: enhance trigger #2286
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
base: main
Are you sure you want to change the base?
docs: enhance trigger #2286
Conversation
|
Is it ready for review? @fengys1996 |
It's still a draft, and there are still some things to do. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR enhances the trigger documentation by adding comprehensive coverage of trigger status and state management. The update transforms the documentation from a Vector-based monitoring example to a clearer, self-contained tutorial focused on alert state transitions.
Key Changes:
- Added a "Key Features" section highlighting SQL-native design, multi-stage state management, rich context, and ecosystem compatibility
- Restructured the quick start example to use a simpler
load1table with a bash script for data simulation instead of Vector - Added detailed coverage of trigger status queries and alert state transitions (pending → firing → inactive) with example outputs
- Expanded the reference section to include links to INFORMATION_SCHEMA.TRIGGERS and INFORMATION_SCHEMA.ALERTS
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
docs/enterprise/trigger.md |
English version enhanced with state management details, simplified examples, and new status query sections |
i18n/zh/docusaurus-plugin-content-docs/current/enterprise/trigger.md |
Chinese translation with equivalent content updates |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
What's Changed in this PR
This pr mainly add a description of the trigger status to enhance the trigger doc.
TODO:
Checklist
sidebars.tsmatches the current document structure when you changed the document structure.