Skip to content

Commit 4443d74

Browse files
authored
docs: added cloud notifications guide (medusajs#12756)
* docs: added cloud notifications guide * fixes
1 parent f12fb7d commit 4443d74

File tree

5 files changed

+87
-1
lines changed

5 files changed

+87
-1
lines changed
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
import { InlineIcon } from "docs-ui"
2+
import { BellAlert } from "@medusajs/icons"
3+
4+
export const metadata = {
5+
title: `Notifications`,
6+
}
7+
8+
# {metadata.title}
9+
10+
In this guide, you'll learn about the notifications you receive in Cloud and how to view them.
11+
12+
## Notifications Overview
13+
14+
Cloud shows you notifications related to your organization, projects, environments, and deployments. These notifications keep you updated without needing to manually check for changes.
15+
16+
### Notification Types
17+
18+
Notifications may be related to:
19+
20+
- **Payment updates**: Whether a Cloud payment subscription succeeded or failed.
21+
- **Database Dump Import / Export**: Notification when a database dump import or export is completed.
22+
- **Build and deployment failure**: Notification when a project's build or deployment fails.
23+
- **Build and deployment recovery**: Notification after a project's build that previously failed was successful.
24+
25+
---
26+
27+
## How to View Notifications
28+
29+
### Notifications Sidebar
30+
31+
The notifications sidebar shows you a history of all your organization's notifications.
32+
33+
To open the notifications sidebar, click on the <InlineIcon Icon={BellAlert} alt="bell" /> icon at the top right of the Cloud dashboard.
34+
35+
![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)
36+
37+
This will open the notifications sidebar, where you can see all notifications related to your organization.
38+
39+
<Note title="Tip">
40+
41+
To view the notifications for a different organization, learn how to [switch organizations](../organizations/page.mdx#switch-organization).
42+
43+
</Note>
44+
45+
![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)
46+
47+
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.
48+
49+
### Toast Notifications
50+
51+
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.
52+
53+
![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)

www/apps/cloud/generated/edit-dates.mjs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@ export const generatedEditDates = {
44
"app/projects/page.mdx": "2025-06-17T11:20:16.174Z",
55
"app/environments/page.mdx": "2025-06-17T11:12:50.824Z",
66
"app/deployments/page.mdx": "2025-06-17T11:17:03.236Z",
7-
"app/organizations/page.mdx": "2025-06-17T10:48:50.969Z"
7+
"app/organizations/page.mdx": "2025-06-17T10:48:50.969Z",
8+
"app/notifications/page.mdx": "2025-06-17T12:29:18.819Z"
89
}

www/apps/cloud/generated/sidebar.mjs

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,23 @@ export const generatedSidebars = [
5454
"children": []
5555
}
5656
]
57+
},
58+
{
59+
"loaded": true,
60+
"isPathHref": true,
61+
"type": "category",
62+
"title": "Monitoring & Support",
63+
"initialOpen": true,
64+
"children": [
65+
{
66+
"loaded": true,
67+
"isPathHref": true,
68+
"type": "link",
69+
"title": "Notifications",
70+
"path": "/notifications",
71+
"children": []
72+
}
73+
]
5774
}
5875
]
5976
}

www/apps/cloud/sidebar.mjs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,18 @@ export const sidebar = [
3939
},
4040
],
4141
},
42+
{
43+
type: "category",
44+
title: "Monitoring & Support",
45+
initialOpen: true,
46+
children: [
47+
{
48+
type: "link",
49+
title: "Notifications",
50+
path: "/notifications",
51+
},
52+
],
53+
},
4254
],
4355
},
4456
]

www/packages/docs-ui/src/components/MDXComponents/index.tsx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,9 @@ export const MDXComponents: MDXComponentsType = {
121121
return <ZoomImg {...rest} />
122122
},
123123
a: Link,
124+
strong: ({ className, ...props }: React.HTMLAttributes<HTMLElement>) => {
125+
return <strong className={clsx("txt-medium-plus", className)} {...props} />
126+
},
124127
}
125128

126129
export const Hr = MDXComponents["hr"] as () => React.JSX.Element

0 commit comments

Comments
 (0)