docs: added cloud notifications guide (#12756)

* docs: added cloud notifications guide

* fixes
This commit is contained in:
Shahed Nasser
2025-06-17 17:23:27 +03:00
committed by GitHub
parent f12fb7dfad
commit 4443d74b61
5 changed files with 87 additions and 1 deletions

View File

@@ -0,0 +1,53 @@
import { InlineIcon } from "docs-ui"
import { BellAlert } from "@medusajs/icons"
export const metadata = {
title: `Notifications`,
}
# {metadata.title}
In this guide, you'll learn about the notifications you receive in Cloud and how to view them.
## Notifications Overview
Cloud shows you notifications related to your organization, projects, environments, and deployments. These notifications keep you updated without needing to manually check for changes.
### Notification Types
Notifications may be related to:
- **Payment updates**: Whether a Cloud payment subscription succeeded or failed.
- **Database Dump Import / Export**: Notification when a database dump import or export is completed.
- **Build and deployment failure**: Notification when a project's build or deployment fails.
- **Build and deployment recovery**: Notification after a project's build that previously failed was successful.
---
## How to View Notifications
### Notifications Sidebar
The notifications sidebar shows you a history of all your organization's notifications.
To open the notifications sidebar, click on the <InlineIcon Icon={BellAlert} alt="bell" /> icon at the top right of the Cloud dashboard.
![Bell icon at the top right of the Cloud dashboard](https://res.cloudinary.com/dza7lstvk/image/upload/v1750161444/Cloud/CleanShot_2025-06-17_at_14.56.58_2x_yccifu.png)
This will open the notifications sidebar, where you can see all notifications related to your organization.
<Note title="Tip">
To view the notifications for a different organization, learn how to [switch organizations](../organizations/page.mdx#switch-organization).
</Note>
![Notifications sidebar showing a list of notifications](https://res.cloudinary.com/dza7lstvk/image/upload/v1750161526/Cloud/CleanShot_2025-06-17_at_14.58.26_2x_dij4pg.png)
Actionable notifications will have a link that you can click to go to the relevant page. For example, if a database dump export was completed, you can click the link to download the dump.
### Toast Notifications
Cloud also shows you toast notifications at the top right of the dashboard when you receive a new notification. These notifications appear momentarily and then disappear. They're helpful to quickly inform you about important updates.
![Toast notification showing a new notification](https://res.cloudinary.com/dza7lstvk/image/upload/v1750161675/Cloud/CleanShot_2025-06-17_at_14.56.06_2x_fsu5ny.png)

View File

@@ -4,5 +4,6 @@ export const generatedEditDates = {
"app/projects/page.mdx": "2025-06-17T11:20:16.174Z",
"app/environments/page.mdx": "2025-06-17T11:12:50.824Z",
"app/deployments/page.mdx": "2025-06-17T11:17:03.236Z",
"app/organizations/page.mdx": "2025-06-17T10:48:50.969Z"
"app/organizations/page.mdx": "2025-06-17T10:48:50.969Z",
"app/notifications/page.mdx": "2025-06-17T12:29:18.819Z"
}

View File

@@ -54,6 +54,23 @@ export const generatedSidebars = [
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Monitoring & Support",
"initialOpen": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"title": "Notifications",
"path": "/notifications",
"children": []
}
]
}
]
}

View File

@@ -39,6 +39,18 @@ export const sidebar = [
},
],
},
{
type: "category",
title: "Monitoring & Support",
initialOpen: true,
children: [
{
type: "link",
title: "Notifications",
path: "/notifications",
},
],
},
],
},
]

View File

@@ -121,6 +121,9 @@ export const MDXComponents: MDXComponentsType = {
return <ZoomImg {...rest} />
},
a: Link,
strong: ({ className, ...props }: React.HTMLAttributes<HTMLElement>) => {
return <strong className={clsx("txt-medium-plus", className)} {...props} />
},
}
export const Hr = MDXComponents["hr"] as () => React.JSX.Element