Events in TiDB Premium: Developer guide changes - #23638
Conversation
Documentation changes for Events in TiDB Premium.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
📝 WalkthroughWalkthroughChangesEvent documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: 🔵 Low · up to The documentation currently includes Starter/Essential-only event rows in the Dedicated plan section, which could mislead users about supported events. This is a localized documentation correctness issue and is mergeable with owner awareness and a follow-up to split or relocate those rows. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.) ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 64def6ef-ccbe-44e1-8d32-ffc4d1dd2457
📒 Files selected for processing (2)
tidb-cloud/monitoring-concepts.mdtidb-cloud/tidb-cloud-events.md
Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 05dcc608-d41e-43fb-9e27-62c826f3a28d
📒 Files selected for processing (2)
tidb-cloud/features.mdtidb-cloud/tidb-cloud-events.md
Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.
| <CustomContent plan="starter,essential,dedicated"> | ||
|
|
||
| TiDB Cloud logs the following types of events: |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Do not expose Starter and Essential-only rows on Dedicated pages.
This block now renders for dedicated, but rows such as UpdateSpendingLimit and ResourceLimitation still describe Starter and Essential instances. Split the table by plan, or keep those rows outside the Dedicated block before publishing.
As per path instructions, a committable suggestion is not appropriate because the fix requires moving non-contiguous table rows.
Source: Path instructions
Documentation changes for Events in TiDB Premium.
First-time contributors' checklist
What is changed, added or deleted? (Required)
With this feature, we are enabling Events in TiDB Premium. The changes include:
Events console will be visible in TiDB Premium
A list of Events that cause a change to Premium instance will show up
Each Event will carry supporting information like who triggered it, timestamp, etc.
Documentation changes are now mentioning Premium wherever Events are described.
A new section adds list of events supported in TiDB Premium.
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
https://pingcap.feishu.cn/wiki/YXtIwQ8rxiCaiAkD0QcceCBlnog
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit