Skip to content
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.

Sign up for GitHub

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

cloud: add the notification doc #19953

Merged
merged 10 commits into from
Jan 15, 2025
Merged

cloud: add the notification doc #19953

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2c05e59
add the notification doc
qiancai Jan 9, 2025
b933c9f
add the notification doc to the toc
qiancai Jan 10, 2025
99ea6b1
Merge branch 'release-8.1' into add-notification-doc
qiancai Jan 10, 2025
0a13639
Update notifications.md
qiancai Jan 10, 2025
86274a8
Update notifications.md
qiancai Jan 13, 2025
c9efd75
Update notifications.md
qiancai Jan 13, 2025
8e2e1f9
wording updates
qiancai Jan 13, 2025
37f38c8
Update notifications.md
qiancai Jan 13, 2025
69c6fbd
add svg for the bell icon
qiancai Jan 13, 2025
5fe9f6e
Apply suggestions from code review
qiancai Jan 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions TOC-tidb-cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -786,6 +786,7 @@
- [URI Formats of External Storage Services](/external-storage-uri.md)
- [DDL Execution Principles and Best Practices](/ddl-introduction.md)
- [Troubleshoot Inconsistency Between Data and Indexes](/troubleshoot-data-inconsistency-errors.md)
- [Notifications](/tidb-cloud/notifications.md)
- [Support](/tidb-cloud/tidb-cloud-support.md)
- [Glossary](/tidb-cloud/tidb-cloud-glossary.md)
- FAQs
Expand Down
56 changes: 56 additions & 0 deletions tidb-cloud/notifications.md
View file
Open in desktop
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

preview: https://pr.pingcap-docsite-preview.pages.dev/tidbcloud/notifications

Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: Notifications in the TiDB Cloud Console
summary: Learn about notifications in the TiDB Cloud console, including notification types, purposes, and how to view them.
---

# Notifications in the TiDB Cloud Console

Check warning on line 6 in tidb-cloud/notifications.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[PingCAP.console] Use 'TiDB Cloud console' instead of 'TiDB Cloud Console'.

Raw Output:
{"message": "[PingCAP.console] Use 'TiDB Cloud console' instead of 'TiDB Cloud Console'.", "location": {"path": "tidb-cloud/notifications.md", "range": {"start": {"line": 6, "column": 24}}}, "severity": "INFO"}

The [TiDB Cloud console](https://tidbcloud.com/) provides notifications to keep you informed about important updates, system messages, product changes, billing reminders, and other relevant information. These notifications help you stay up-to-date and take necessary actions without leaving the console.

## Notification types

You might receive different types of notifications in the TiDB Cloud console, such as:

- **Informational notifications**

Provide helpful updates, such as feature usage tips, application changes, or reminders for upcoming events.

- **Actionable notifications**

Prompt you to perform specific actions, such as adding a credit card.

- **Alert notifications**

Notify you of critical issues or urgent events requiring immediate attention, such as system errors, security warnings, or important updates.

- **Billing notifications**

Deliver updates about billing-related activities, such as credit and discount updates.

- **Feedback notifications**

Request feedback on your experience with a feature, such as rating a recent interaction or completing a survey.

## Notifications list

The following table lists the notifications available in TiDB Cloud, along with their trigger events and recipients:

| Notification | Trigger event | Notification recipient |
| --- | --- | --- |
| TiDB Cloud Serverless cluster creation | A [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) cluster is created. | All project members |
| TiDB Cloud Serverless cluster deletion | A TiDB Cloud Serverless cluster is deleted. | All project members |
| TiDB Cloud Dedicated cluster creation | A [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) cluster is created. | All project members |
| TiDB Cloud Dedicated cluster deletion | A TiDB Cloud Dedicated cluster is deleted. | All project members |
| Organization Budget threshold alert | The organization [budget threshold](/tidb-cloud/tidb-cloud-budget.md) is reached. | `Organization Owner`, `Organization Billing Manager`, and `Organization Billing Viewer` |
| Project Budget threshold alert | The project [budget threshold](/tidb-cloud/tidb-cloud-budget.md) is reached. | `Organization Owner`, `Organization Billing Manager`, `Organization Billing Viewer`, and `Project Owner` |
| Serverless cluster spending limit threshold alert | The [spending limit threshold](/tidb-cloud/manage-serverless-spend-limit.md) for TiDB Cloud Serverless clusters in the organization is reached. | `Organization Owner`, `Organization Billing Manager`, `Organization Billing Viewer`, and `Project Owner` |
| Credits update | [Credits](/tidb-cloud/tidb-cloud-billing.md#credits) for the organization are applied, fully used, reclaimed, or expired. | `Organization Owner`, `Organization Billing Manager`, and `Organization Billing Viewer` |
| Discount update | [Discounts](/tidb-cloud/tidb-cloud-billing.md#discounts) for the organization are applied, reclaimed, or expired. | `Organization Owner`, `Organization Billing Manager`, and `Organization Billing Viewer` |
| Marketplace update | The organization has a subscription or unsubscription through a cloud provider marketplace. | All organization members |
| Support plan update | The support plan subscription for the organization is changed. | All organization members |

## View notifications

When a new notification is available, a blue dot is displayed on the <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="none" viewBox="0 0 24 24" stroke-width="2"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M9.354 21c.705.622 1.632 1 2.646 1s1.94-.378 2.646-1M18 8A6 6 0 1 0 6 8c0 3.09-.78 5.206-1.65 6.605-.735 1.18-1.102 1.771-1.089 1.936.015.182.054.252.2.36.133.099.732.099 1.928.099H18.61c1.196 0 1.795 0 1.927-.098.147-.11.186-.179.2-.361.014-.165-.353-.755-1.088-1.936C18.78 13.206 18 11.09 18 8Z" stroke-width="inherit"></path></svg> icon in the lower-right corner of the TiDB Cloud console. Click <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="none" viewBox="0 0 24 24" stroke-width="2"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M9.354 21c.705.622 1.632 1 2.646 1s1.94-.378 2.646-1M18 8A6 6 0 1 0 6 8c0 3.09-.78 5.206-1.65 6.605-.735 1.18-1.102 1.771-1.089 1.936.015.182.054.252.2.36.133.099.732.099 1.928.099H18.61c1.196 0 1.795 0 1.927-.098.147-.11.186-.179.2-.361.014-.165-.353-.755-1.088-1.936C18.78 13.206 18 11.09 18 8Z" stroke-width="inherit"></path></svg> to view the notification.

Alternatively, click <MDSvgIcon name="icon-top-account-settings" /> in the lower-left corner of the TiDB Cloud console, and then click **Notifications** to view a list of all notifications, where you can click a specific notification for more details.
Loading