docs: prepare cloud docs (#12784)

* initial

* fixes

* docs: prepare cloud docs
This commit is contained in:
Shahed Nasser
2025-06-20 12:59:38 +03:00
committed by GitHub
parent c2f91c8a8a
commit 5122ced9f6
30 changed files with 241 additions and 46 deletions
+1 -1
View File
@@ -26,7 +26,7 @@ With Cloud, you maintain full customization control as you deploy your own modul
Cloud users also gets early access to new features (for example, Gift Cards and Draft Orders).
[Sign up and learn more about Cloud](https://medusajs.com/pricing/)
[Sign up and learn more about Cloud](!cloud!)
---
@@ -31,7 +31,7 @@ In this tutorial, you'll learn how to implement a loyalty points system in Medus
<Note title="Looking for a straightforward implementation?">
Cloud provides a beta Store Credits feature that facilitates building a loyalty point system. [Get in touch](https://medusajs.com/contact) for early access.
Cloud provides a beta Loyalty Plugin feature that facilitates building a loyalty point system. Refer to the [Cloud Loyalty Plugin](!cloud!/loyalty-plugin) documentation to learn more.
</Note>
@@ -8,6 +8,12 @@ export const metadata = {
The Redis Cache Module uses Redis to cache data in your store. In production, it's recommended to use this module.
<Note title="Using Cloud?">
Our Cloud offering automatically provisions a Redis instance and configures the Redis Cache Module for you. Learn more in the [Redis](!cloud!/redis) Cloud documentation.
</Note>
---
## Register the Redis Cache Module
@@ -12,6 +12,12 @@ It's powered by BullMQ and `io-redis`. BullMQ is responsible for the message que
In production, it's recommended to use this module.
<Note title="Using Cloud?">
Our Cloud offering automatically provisions a Redis instance and configures the Redis Event Module for you. Learn more in the [Redis](!cloud!/redis) Cloud documentation.
</Note>
---
## Register the Redis Event Module
@@ -13,7 +13,7 @@ The S3 File Module Provider integrates Amazon S3 and services following a compat
<Note title="Looking for managed storage?">
Cloud offers a managed file storage solution with AWS S3 for your Medusa application. Contact the [sales team](https://medusajs.com/pricing/) to learn more.
Cloud offers a managed file storage solution with AWS S3 for your Medusa application. Refer to the [S3](!cloud!/s3) Cloud documentation for more details.
</Note>
@@ -10,6 +10,12 @@ The Redis Locking Module Provider uses Redis to manage locks across multiple ins
This provider is recommended for production environments where Medusa is running in a multi-instance setup.
<Note title="Using Cloud?">
Our Cloud offering automatically provisions a Redis instance and configures the Redis Locking Module Provider for you. Learn more in the [Redis](!cloud!/redis) Cloud documentation.
</Note>
---
## Register the Redis Locking Module Provider
@@ -8,6 +8,12 @@ export const metadata = {
The Redis Workflow Engine Module uses Redis to track workflow executions and handle their subscribers. In production, it's recommended to use this module.
<Note title="Using Cloud?">
Our Cloud offering automatically provisions a Redis instance and configures the Redis Workflow Engine Module for you. Learn more in the [Redis](!cloud!/redis) Cloud documentation.
</Note>
---
## Register the Redis Workflow Engine Module
@@ -60,7 +60,7 @@ For example, you can integrate [Stripe](../../commerce-modules/payment/payment-p
## Deploy the Medusa Application
The most efficient way to deploy your Medusa application is to use [Cloud](https://medusajs.com/pricing). Cloud is our managed services offering that makes deploying and operating Medusa applications possible without having to worry about configuring, scaling, and maintaining infrastructure. Cloud hosts your server, Admin dashboard, database, and Redis instance.
The most efficient way to deploy your Medusa application is to use [Cloud](!cloud!). Cloud is our managed services offering that makes deploying and operating Medusa applications possible without having to worry about configuring, scaling, and maintaining infrastructure. Cloud hosts your server, Admin dashboard, database, and Redis instance.
With Cloud, you maintain full customization control as you deploy your own modules and customizations directly from GitHub:
@@ -73,7 +73,7 @@ Our documentation also provides a step-by-step guides to deploy your Medusa appl
<CardList itemsPerRow={2} items={[
{
href: "https://medusajs.com/pricing",
href: "!cloud!",
title: "Sign up for Cloud",
text: "Learn more about Cloud and sign up to get started.",
icon: AcademicCapSolid,
+8 -8
View File
@@ -103,7 +103,7 @@ export const generatedEditDates = {
"app/deployment/admin/vercel/page.mdx": "2024-10-16T08:10:29.377Z",
"app/deployment/medusa-application/railway/page.mdx": "2025-04-17T08:28:58.981Z",
"app/deployment/storefront/vercel/page.mdx": "2025-05-20T07:51:40.712Z",
"app/deployment/page.mdx": "2025-05-20T07:51:40.711Z",
"app/deployment/page.mdx": "2025-06-20T08:36:52.947Z",
"app/integrations/page.mdx": "2025-05-26T14:47:43.842Z",
"app/medusa-cli/page.mdx": "2024-08-28T11:25:32.382Z",
"app/medusa-container-resources/page.mdx": "2025-04-17T08:48:10.255Z",
@@ -113,7 +113,7 @@ export const generatedEditDates = {
"app/recipes/commerce-automation/page.mdx": "2025-05-20T07:51:40.719Z",
"app/recipes/digital-products/examples/standard/page.mdx": "2025-04-24T15:41:05.364Z",
"app/recipes/digital-products/page.mdx": "2025-05-20T07:51:40.719Z",
"app/recipes/ecommerce/page.mdx": "2025-05-20T07:51:40.720Z",
"app/recipes/ecommerce/page.mdx": "2025-06-20T08:37:23.051Z",
"app/recipes/marketplace/examples/vendors/page.mdx": "2025-05-20T07:51:40.721Z",
"app/recipes/marketplace/page.mdx": "2025-05-20T07:51:40.721Z",
"app/recipes/multi-region-store/page.mdx": "2025-05-20T07:51:40.721Z",
@@ -195,16 +195,16 @@ export const generatedEditDates = {
"app/commerce-modules/api-key/page.mdx": "2025-04-17T08:48:16.605Z",
"app/commerce-modules/auth/create-actor-type/page.mdx": "2025-05-20T07:51:40.707Z",
"app/infrastructure-modules/page.mdx": "2025-05-21T13:01:59.821Z",
"app/infrastructure-modules/workflow-engine/redis/page.mdx": "2024-11-19T16:37:47.262Z",
"app/infrastructure-modules/workflow-engine/redis/page.mdx": "2025-06-20T08:34:21.977Z",
"app/infrastructure-modules/notification/sendgrid/page.mdx": "2025-05-20T07:51:40.715Z",
"app/commerce-modules/api-key/concepts/page.mdx": "2024-10-07T13:59:37.529Z",
"app/infrastructure-modules/workflow-engine/page.mdx": "2025-04-17T08:29:00.881Z",
"app/infrastructure-modules/cache/page.mdx": "2025-04-17T08:29:00.741Z",
"app/infrastructure-modules/file/s3/page.mdx": "2025-02-11T16:57:46.709Z",
"app/infrastructure-modules/file/s3/page.mdx": "2025-06-20T08:38:24.029Z",
"app/commerce-modules/api-key/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/api-key/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/infrastructure-modules/cache/redis/page.mdx": "2024-11-19T16:37:47.261Z",
"app/infrastructure-modules/event/redis/page.mdx": "2025-03-27T14:53:13.310Z",
"app/infrastructure-modules/cache/redis/page.mdx": "2025-06-20T08:33:53.038Z",
"app/infrastructure-modules/event/redis/page.mdx": "2025-06-20T08:34:03.057Z",
"app/infrastructure-modules/event/local/page.mdx": "2025-03-27T14:53:13.309Z",
"app/infrastructure-modules/workflow-engine/in-memory/page.mdx": "2024-11-19T16:37:47.262Z",
"app/infrastructure-modules/cache/in-memory/page.mdx": "2024-11-19T16:37:47.261Z",
@@ -6022,7 +6022,7 @@ export const generatedEditDates = {
"app/references-overview/page.mdx": "2025-03-10T12:55:49.803Z",
"app/infrastructure-modules/locking/page.mdx": "2025-04-17T08:29:00.564Z",
"app/infrastructure-modules/locking/postgres/page.mdx": "2025-03-27T14:53:13.310Z",
"app/infrastructure-modules/locking/redis/page.mdx": "2025-03-27T14:53:13.310Z",
"app/infrastructure-modules/locking/redis/page.mdx": "2025-06-20T08:34:12.702Z",
"references/locking/interfaces/locking.ILockingModule/page.mdx": "2025-05-20T07:51:40.955Z",
"references/locking/interfaces/locking.ILockingProvider/page.mdx": "2025-05-20T07:51:40.955Z",
"references/modules/locking/page.mdx": "2025-03-12T12:28:30.419Z",
@@ -6051,7 +6051,7 @@ export const generatedEditDates = {
"app/integrations/guides/algolia/page.mdx": "2025-05-20T07:51:40.715Z",
"app/integrations/guides/magento/page.mdx": "2025-05-20T07:51:40.716Z",
"app/js-sdk/auth/overview/page.mdx": "2025-03-28T08:05:32.622Z",
"app/how-to-tutorials/tutorials/loyalty-points/page.mdx": "2025-05-01T15:33:24.035Z",
"app/how-to-tutorials/tutorials/loyalty-points/page.mdx": "2025-06-20T08:35:30.861Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.plugin/page.mdx": "2025-04-11T09:04:55.084Z",
"references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.createAddress/page.mdx": "2025-05-20T07:51:40.936Z",
"references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.deleteAddress/page.mdx": "2025-04-11T09:04:54.015Z",
@@ -1309,14 +1309,6 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "processPaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -5351,14 +5343,6 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "processPaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -6616,6 +6600,14 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/declineOrderTransferRequestWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "deleteDraftOrdersWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteDraftOrdersWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -7259,6 +7251,14 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteClaimsStep",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "deleteDraftOrdersStep",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteDraftOrdersStep",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -537,8 +537,8 @@ const generatedgeneratedHowToTutorialsSidebarSidebar = {
"loaded": true,
"isPathHref": true,
"type": "link",
"title": "Medusa Cloud",
"path": "https://medusajs.com/pricing",
"title": "Cloud",
"path": "https://docs.medusajs.com/cloud",
"children": []
},
{
+3
View File
@@ -32,6 +32,9 @@ const mdxPluginOptions = {
api: {
url: process.env.NEXT_PUBLIC_API_URL,
},
cloud: {
url: process.env.NEXT_PUBLIC_CLOUD_URL,
},
},
useBaseUrl:
process.env.NODE_ENV === "production" ||
+3
View File
@@ -42,6 +42,9 @@ const withMDX = mdx({
projectPath: path.resolve("..", "api-reference"),
skipSlugValidation: true,
},
cloud: {
projectPath: path.resolve("..", "cloud"),
},
},
},
],
@@ -182,8 +182,8 @@ While tutorials show you a specific use case, they also help you understand how
},
{
type: "link",
title: "Medusa Cloud",
path: "https://medusajs.com/pricing",
title: "Cloud",
path: "https://docs.medusajs.com/cloud",
},
{
type: "sub-category",