From 4443d74b611a524abc48ec436aabcbd8ad692047 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 17 Jun 2025 17:23:27 +0300 Subject: [PATCH] docs: added cloud notifications guide (#12756) * docs: added cloud notifications guide * fixes --- www/apps/cloud/app/notifications/page.mdx | 53 +++++++++++++++++++ www/apps/cloud/generated/edit-dates.mjs | 3 +- www/apps/cloud/generated/sidebar.mjs | 17 ++++++ www/apps/cloud/sidebar.mjs | 12 +++++ .../src/components/MDXComponents/index.tsx | 3 ++ 5 files changed, 87 insertions(+), 1 deletion(-) create mode 100644 www/apps/cloud/app/notifications/page.mdx diff --git a/www/apps/cloud/app/notifications/page.mdx b/www/apps/cloud/app/notifications/page.mdx new file mode 100644 index 0000000000..35813e7cbc --- /dev/null +++ b/www/apps/cloud/app/notifications/page.mdx @@ -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 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. + + + +To view the notifications for a different organization, learn how to [switch organizations](../organizations/page.mdx#switch-organization). + + + +![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) \ No newline at end of file diff --git a/www/apps/cloud/generated/edit-dates.mjs b/www/apps/cloud/generated/edit-dates.mjs index 3994f9d839..4377ee001f 100644 --- a/www/apps/cloud/generated/edit-dates.mjs +++ b/www/apps/cloud/generated/edit-dates.mjs @@ -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" } \ No newline at end of file diff --git a/www/apps/cloud/generated/sidebar.mjs b/www/apps/cloud/generated/sidebar.mjs index a119cf3fa4..213307c02e 100644 --- a/www/apps/cloud/generated/sidebar.mjs +++ b/www/apps/cloud/generated/sidebar.mjs @@ -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": [] + } + ] } ] } diff --git a/www/apps/cloud/sidebar.mjs b/www/apps/cloud/sidebar.mjs index 5d820f17f4..a8e36214e0 100644 --- a/www/apps/cloud/sidebar.mjs +++ b/www/apps/cloud/sidebar.mjs @@ -39,6 +39,18 @@ export const sidebar = [ }, ], }, + { + type: "category", + title: "Monitoring & Support", + initialOpen: true, + children: [ + { + type: "link", + title: "Notifications", + path: "/notifications", + }, + ], + }, ], }, ] diff --git a/www/packages/docs-ui/src/components/MDXComponents/index.tsx b/www/packages/docs-ui/src/components/MDXComponents/index.tsx index 10c91970a0..9c821eaa0b 100644 --- a/www/packages/docs-ui/src/components/MDXComponents/index.tsx +++ b/www/packages/docs-ui/src/components/MDXComponents/index.tsx @@ -121,6 +121,9 @@ export const MDXComponents: MDXComponentsType = { return }, a: Link, + strong: ({ className, ...props }: React.HTMLAttributes) => { + return + }, } export const Hr = MDXComponents["hr"] as () => React.JSX.Element