docs: added cloud notifications guide (#12756)
* docs: added cloud notifications guide * fixes
This commit is contained in:
@@ -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.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
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>
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|

|
||||||
@@ -4,5 +4,6 @@ export const generatedEditDates = {
|
|||||||
"app/projects/page.mdx": "2025-06-17T11:20:16.174Z",
|
"app/projects/page.mdx": "2025-06-17T11:20:16.174Z",
|
||||||
"app/environments/page.mdx": "2025-06-17T11:12:50.824Z",
|
"app/environments/page.mdx": "2025-06-17T11:12:50.824Z",
|
||||||
"app/deployments/page.mdx": "2025-06-17T11:17:03.236Z",
|
"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"
|
||||||
}
|
}
|
||||||
@@ -54,6 +54,23 @@ export const generatedSidebars = [
|
|||||||
"children": []
|
"children": []
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"loaded": true,
|
||||||
|
"isPathHref": true,
|
||||||
|
"type": "category",
|
||||||
|
"title": "Monitoring & Support",
|
||||||
|
"initialOpen": true,
|
||||||
|
"children": [
|
||||||
|
{
|
||||||
|
"loaded": true,
|
||||||
|
"isPathHref": true,
|
||||||
|
"type": "link",
|
||||||
|
"title": "Notifications",
|
||||||
|
"path": "/notifications",
|
||||||
|
"children": []
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -39,6 +39,18 @@ export const sidebar = [
|
|||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
type: "category",
|
||||||
|
title: "Monitoring & Support",
|
||||||
|
initialOpen: true,
|
||||||
|
children: [
|
||||||
|
{
|
||||||
|
type: "link",
|
||||||
|
title: "Notifications",
|
||||||
|
path: "/notifications",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -121,6 +121,9 @@ export const MDXComponents: MDXComponentsType = {
|
|||||||
return <ZoomImg {...rest} />
|
return <ZoomImg {...rest} />
|
||||||
},
|
},
|
||||||
a: Link,
|
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
|
export const Hr = MDXComponents["hr"] as () => React.JSX.Element
|
||||||
|
|||||||
Reference in New Issue
Block a user