Skip to content

docs: add enterprise dashboard webhook trigger docs#2592

Merged
v0y4g3r merged 4 commits into
mainfrom
docs/webhook
Jul 1, 2026
Merged

docs: add enterprise dashboard webhook trigger docs#2592
v0y4g3r merged 4 commits into
mainfrom
docs/webhook

Conversation

@v0y4g3r

@v0y4g3r v0y4g3r commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add a standalone Enterprise Management Console page for webhook triggers based on cluster resource usage metrics.
  • Document configuration, supported metrics and roles, firing/resolved payload behavior, and in-memory state limitations.
  • Add sidebar and console overview links, plus matching version 1.1 and Chinese translation pages.

Availability

This feature is enterprise-only and available when the enterprise dashboard is deployed with dashboard version v0.2.0-alpha.10 or later.

Test Plan

  • node --input-type=module MDX compilation for changed and new docs pages
  • git diff --check
  • pnpm build

v0y4g3r added 2 commits June 30, 2026 15:09
Introduce a new documentation page for the enterprise webhook trigger
feature, which monitors cluster resource usage metrics and sends HTTP
notifications when configured thresholds are crossed.  Covers
configuration, payload schema, and behavioral notes on firing/resolved
alert cycles.

Also update the console-ui overview pages (English and Chinese, current
and versioned 1.1) to cross-reference the new page, and register the
corresponding sidebar entry.

Affected files:

- docs/enterprise/console-ui/webhook-triggers.md
- versioned_docs/version-1.1/enterprise/console-ui/webhook-triggers.md
- i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui/webhook-triggers.md
- i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui/webhook-triggers.md
- docs/enterprise/console-ui.md
- versioned_docs/version-1.1/enterprise/console-ui.md
- i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui.md
- i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui.md
- sidebars.ts

Signed-off-by: Lei Mao <lei.mao@solidigm.com>
Signed-off-by: Lei, HUANG <ratuthomm@gmail.com>
The webhook triggers feature requires the enterprise dashboard to be deployed at version `v0.2.0-alpha.10` or later.

Updated files:

- `docs/enterprise/console-ui/webhook-triggers.md`

- `i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui/webhook-triggers.md`

- `i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui/webhook-triggers.md`

- `versioned_docs/version-1.1/enterprise/console-ui/webhook-triggers.md`

Signed-off-by: Lei, HUANG <ratuthomm@gmail.com>
@v0y4g3r v0y4g3r changed the title Docs: add enterprise dashboard webhook trigger docs docs add enterprise dashboard webhook trigger docs Jun 30, 2026
@v0y4g3r v0y4g3r changed the title docs add enterprise dashboard webhook trigger docs docs: add enterprise dashboard webhook trigger docs Jun 30, 2026
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jun 30, 2026

Copy link
Copy Markdown

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: faf38ee
Status: ✅  Deploy successful!
Preview URL: https://11a68c9b.greptime-docs.pages.dev
Branch Preview URL: https://docs-webhook.greptime-docs.pages.dev

View logs

@v0y4g3r v0y4g3r marked this pull request as ready for review June 30, 2026 07:30
@v0y4g3r v0y4g3r requested a review from fengjiachun as a code owner June 30, 2026 07:30
Copilot AI review requested due to automatic review settings June 30, 2026 07:30
@v0y4g3r v0y4g3r requested a review from killme2008 as a code owner June 30, 2026 07:30

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation for the Enterprise Management Console “Webhook Triggers” feature (resource-usage-based HTTP notifications), including configuration and payload details, and wires the new page into navigation/overview content for both current docs and v1.1 (plus Chinese translations).

Changes:

  • Added new “Webhook Triggers” documentation pages (current + v1.1, EN + zh).
  • Linked the new feature from the Management Console overview pages.
  • Added the new doc to the current docs sidebar.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
versioned_docs/version-1.1/enterprise/console-ui/webhook-triggers.md New v1.1 EN doc page describing webhook trigger configuration and payloads.
versioned_docs/version-1.1/enterprise/console-ui.md Adds a Webhook Triggers mention/link in the v1.1 console overview (also touches Continuous Profiling link).
sidebars.ts Adds the new Webhook Triggers page to the current docs sidebar navigation.
i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui/webhook-triggers.md New v1.1 zh translation for the webhook triggers page.
i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui.md Adds a Webhook Triggers mention/link in the v1.1 zh console overview (also touches Continuous Profiling link).
i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui/webhook-triggers.md New current zh translation for the webhook triggers page.
i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui.md Adds a Webhook Triggers mention/link in the current zh console overview.
docs/enterprise/console-ui/webhook-triggers.md New current EN doc page describing webhook trigger configuration and payloads.
docs/enterprise/console-ui.md Adds a Webhook Triggers mention/link in the current EN console overview.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread versioned_docs/version-1.1/enterprise/console-ui.md Outdated
Comment thread i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui.md Outdated
Comment thread sidebars.ts

@discord9 discord9 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I left two minor follow-up comments; neither blocks this PR.

Comment thread versioned_docs/version-1.1/enterprise/console-ui.md Outdated
Comment thread docs/enterprise/console-ui/webhook-triggers.md
@v0y4g3r v0y4g3r merged commit 6342628 into main Jul 1, 2026
5 checks passed
@v0y4g3r v0y4g3r deleted the docs/webhook branch July 1, 2026 03:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants