asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: improve headings and context in Cloud docs (#13757)

Browse Source
This commit is contained in:
Shahed Nasser
2025-10-15 18:49:48 +03:00
committed by GitHub
parent 4e3090ab26
commit 8bb036457c
13 changed files with 68 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
www/apps/cloud/app/database/page.mdx
View File

@@ -4,11 +4,11 @@ export const metadata = {
# {metadata.title}
In this guide, you'll learn about the managed database service that Medusa provides as part of your project environments.
In this guide, you'll learn about the managed database service that Medusa provides as part of your project environments on Cloud.
## Managed Database Service
## Managed Database Service on Cloud
Medusa provisions and manages databases for each of your environments.
Medusa provisions and manages databases for each of your environments on Cloud.
Each project environment has a dedicated PostgreSQL database. These databases are entirely isolated from one another.
@@ -18,25 +18,25 @@ This isolation allows you to safely make or test changes in environments without
---
## Database Configurations
## Cloud Database Configurations
Medusa automatically configures the database for your environments. So, you don't need to worry about setting up the database, configuring it with your Medusa application, or monitoring performance and availability on your end.
Medusa automatically configures the database for your environments on Cloud. So, you don't need to worry about setting up the database, configuring it with your Medusa application, or monitoring performance and availability on your end.
---
## Database Backups
## Cloud Database Backups
Medusa provides automatic backups for your environment databases. These backups are retained for 14 days and allow you to restore your database to a previous state, if needed.
Medusa provides automatic backups for your environment databases on Cloud. These backups are retained for 14 days and allow you to restore your database to a previous state, if needed.
If you need to restore a database backup, you can contact support to request a point-in-time recovery. This is useful if you accidentally delete data or need to revert changes made to the database.
---
## Connect to the Database
## Connect to a Cloud Database
In some cases, you may need to access the database directly, such as to export or import data.
In some cases, you may need to access your Cloud project's database directly, such as to export or import data.
Medusa gives you read access to your database, which is useful when you need to export data, perform analytics, or troubleshoot issues.
Medusa gives you read access to your Cloud project's database, which is useful when you need to export data, perform analytics, or troubleshoot issues.
To get the read-only connection string for an environment's database:
@@ -58,9 +58,9 @@ After connecting to the database, you can run SQL queries to interact with your
---
## Import/Export Database Dumps
## Import/Export Cloud Database Dumps
Medusa allows you to export and import database dumps for any environment. This is useful for seeding the database with initial data, migrating from other hosting platforms, or debugging issues locally.
Medusa allows you to export and import database dumps for any environment on Cloud. This is useful for seeding the database with initial data, migrating from other hosting platforms, or debugging issues locally.
To import or export a database dump for an environment:
@@ -95,7 +95,7 @@ pg_restore --no-acl --no-owner --no-privileges --clean --if-exists -d 'postgres:
## Change Preview Environment Database
By default, when Medusa creates a [preview environment](../environments/preview/page.mdx), it replicates the Production database. This allows you to test changes in a safe environment that mirrors production, without affecting the live data.
By default, when Medusa creates a [preview environment](../environments/preview/page.mdx) on Cloud, it replicates the Production database. This allows you to test changes in a safe environment that mirrors production, without affecting the live data.
Cloud also allows you to configure which environment's database to replicate the preview database from. For example, you can replicate the Staging environment's database instead of Production.

2
www/apps/cloud/app/deployments/page.mdx
View File

@@ -7,7 +7,7 @@ export const metadata = {
# {metadata.title}
In this guide, you'll learn about deployments, how they're created, and how you can troubleshoot them in Cloud.
In this guide, you'll learn about deployments in Cloud, how they're created, and how you can troubleshoot them.
## Deployments Overview

8
www/apps/cloud/app/environments/environment-variables/page.mdx
View File

@@ -41,7 +41,7 @@ The following environment variable names are reserved by Cloud and you can't use
---
## Add Environment Variables
## Add Environment Variables on Cloud
To add environment variables to an environment:
@@ -67,7 +67,7 @@ After adding the environment variables, you must [redeploy the environment](../l
---
## Edit Environment Variables
## Edit Environment Variables on Cloud
To edit an environment variable:
@@ -92,7 +92,7 @@ After editing the environment variable, you must [redeploy the environment](../l
---
## Delete Environment Variables
## Delete Environment Variables on Cloud
To delete an environment variable:
@@ -112,7 +112,7 @@ After deleting the environment variable, you must [redeploy the environment](../
---
## Export Environment Variables
## Export Environment Variables on Cloud
You can export an environment's variables as a `.env` file. This is useful for debugging issues that require you to have the same environment variables.

2
www/apps/cloud/app/environments/long-lived/page.mdx
View File

@@ -27,7 +27,7 @@ Production and long-lived environments are stable and scalable, making them idea
---
## Create a Long-Lived Environment
## Create a Long-Lived Environment on Cloud
It's recommended to create long-lived environments for different stages of your project's development.

6
www/apps/cloud/app/environments/page.mdx
View File

@@ -4,11 +4,11 @@ export const metadata = {
# {metadata.title}
In this guide, you'll learn about environments, how to create and manage them, and how to use preview environments.
In this guide, you'll learn about environments in Cloud, how to create and manage them, and how to use preview environments.
## Environments Overview
A project can have multiple environments, each representing a different stage of your application. For example, you can have a Production environment for your live application, and a Staging environment for testing new features.
A Cloud project can have multiple environments, each representing a different stage of your application. For example, you can have a Production environment for your live application, and a Staging environment for testing new features.
Each environment has its own resources, such as a database and server instance. By default, a project has at least a Production environment, and you can create custom environments based on your development needs.
@@ -23,7 +23,7 @@ There are two types of environments:
---
## View Project's Environments
## View Project's Environments on Cloud
To view a project's environments:

2
www/apps/cloud/app/environments/preview/page.mdx
View File

@@ -4,7 +4,7 @@ export const metadata = {
# {metadata.title}
A preview environment is a short-lived environment that is automatically created for each pull request (PR) opened towards a branch with a long-lived environment in Cloud.
A preview environment is a short-lived Cloud environment that is automatically created for each pull request (PR) opened towards a branch with a long-lived environment in Cloud.
Preview environments facilitate testing a PR's changes in a live environment before merging them. They allow you to test changes in an environment that closely resembles the target long-lived environment.

16
www/apps/cloud/app/logs/page.mdx
View File

@@ -7,11 +7,11 @@ export const metadata = {
# {metadata.title}
In this guide, you'll learn how to view and manage your environment's logs in Cloud.
In this guide, you'll learn how to view and manage your Cloud environment's logs.
## Logs Overview
Logs are output messages from your Medusa application's build and runtime processes for an environment's deployments.
Logs are output messages from your Medusa application's build and runtime processes for a Cloud environment's deployments.
They include messages logged throughout your application's lifecycle, including messages during the build process, application startup, and runtime operations.
@@ -26,7 +26,7 @@ There are two types of logs for your environment's deployments:
---
## View Build Logs
## View Build Logs on Cloud
Build logs help you identify issues when a deployment fails with the status "Build failed". They can help you debug the build process and understand why the deployment didn't succeed.
@@ -43,7 +43,7 @@ This will open the deployment details page, where you can see the build logs. Th
![Build Logs for a deployment](https://res.cloudinary.com/dza7lstvk/image/upload/v1750248493/Cloud/CleanShot_2025-06-18_at_15.07.29_2x_i9ztnt.png)
### Search Build Logs
### Search Build Logs on Cloud
You can search the build logs using the search bar at the top right of the "Build logs" section. This is useful for finding specific messages or errors in the logs.
@@ -53,7 +53,7 @@ When you enter the search term, you'll see how many results match your search. Y
![Search Build Logs with results highlighted](https://res.cloudinary.com/dza7lstvk/image/upload/v1750316571/Cloud/CleanShot_2025-06-19_at_10.02.36_2x_qzn11c.png)
### Expand and Collapse Build Logs
### Expand and Collapse Build Logs on Cloud
Logs for steps in the build process can be expanded or collapsed to improve readability. This is useful when you have many log messages and want to focus on specific parts of the build process.
@@ -69,7 +69,7 @@ In addition, you can expand or collapse individual steps by clicking the arrow n
![Build logs with one step collapsed](https://res.cloudinary.com/dza7lstvk/image/upload/v1750316810/Cloud/CleanShot_2025-06-19_at_10.06.36_2x_gfkkzj.png)
### Pause Build Logs
### Pause Build Logs on Cloud
When you view the build logs while the build is still in progress, you can pause the logs to stop them from updating in real time. This is useful if you find a log message that you want to read more closely without it being pushed out of view by new log messages.
@@ -77,7 +77,7 @@ To pause the build logs, click the "Pause" button at the bottom right of the pag
![Pause button at the bottom right of the page](https://res.cloudinary.com/dza7lstvk/image/upload/v1750316962/Cloud/CleanShot_2025-06-19_at_10.08.43_2x_buricw.png)
### Download Build Logs
### Download Build Logs on Cloud
You can download the build logs as a `.log` file for offline analysis, sharing with your team, or sharing with Cloud support if you need help debugging a build issue.
@@ -87,7 +87,7 @@ To download build logs, click the <InlineIcon Icon={ArrowDownTray} alt="download
---
## View Runtime Logs
## View Runtime Logs on Cloud
Runtime logs are useful for debugging the live deployment of an environment, especially when the deployment's status is "Deploy failed". They include logs for:

2
www/apps/cloud/app/loyalty-plugin/page.mdx
View File

@@ -10,7 +10,7 @@ In this guide, you'll learn about the loyalty plugin add-on available to Cloud u
Loyalty features are essential for ecommerce applications. They help businesses retain customers and encourage repeat purchases.
When you sign up for Cloud, you can access the Loyalty Plugin in your deployed Medusa applications.
When you sign up for Cloud, you can access the Loyalty Plugin in your Medusa applications deployed on Cloud.
The Loyalty Plugin is an add-on to your Cloud projects. It adds modules, API routes, workflows, and admin customizations that provide loyalty-related features to your Medusa application.

6
www/apps/cloud/app/notifications/page.mdx
View File

@@ -7,11 +7,11 @@ export const metadata = {
# {metadata.title}
In this guide, you'll learn about the notifications you receive in Cloud and how to view them.
In this guide, you'll learn about the notifications you receive from Cloud and how to view them.
## Notifications Overview
Medusa shows you notifications related to your organization, projects, environments, and deployments. These notifications keep you updated without needing to manually check for changes.
Medusa shows you notifications related to your Cloud organization, projects, environments, and deployments. These notifications keep you updated without needing to manually check for changes.
### Notification Types
@@ -24,7 +24,7 @@ Notifications may be related to:
---
## How to View Notifications
## How to View Notifications on Cloud
### Notifications Sidebar

16
www/apps/cloud/app/redis/page.mdx
View File

@@ -4,11 +4,11 @@ export const metadata = {
# {metadata.title}
In this guide, you'll learn about the managed Redis service that Medusa provides as part of your project environments.
In this guide, you'll learn about the managed Redis service that Medusa provides as part of your project environments on Cloud.
## Managed Redis Service
## Managed Redis Service on Cloud
Medusa provisions and manages Redis servers for each of your environments.
Medusa provisions and manages Redis servers for each of your environments on Cloud.
Each project environment has a dedicated Redis server. These Redis servers are entirely isolated from one another, similar to the Postgres databases.
@@ -16,9 +16,9 @@ Each project environment has a dedicated Redis server. These Redis servers are e
---
## Configured Redis Infrastructure Modules
## Configured Redis Infrastructure Modules on Cloud
Medusa automatically configures your Medusa application to use Redis-based Infrastructure Modules, including:
Medusa automatically configures your Medusa application hosted on Cloud to use Redis-based Infrastructure Modules, including:
- [Redis Event Module](!resources!/infrastructure-modules/event/redis)
- [Redis Cache Module](!resources!/infrastructure-modules/cache/redis)
@@ -33,13 +33,13 @@ If you're using a Medusa version before v2.7.0, contact support for assistance i
</Note>
### Access Redis Configurations
### Access Redis Configurations on Cloud
Since Cloud is a managed service, you can't directly access your Redis instance or its configurations. Medusa also doesn't expose the Redis instance connection or configuration details.
### Override Redis Configurations
### Override Redis Configurations on Cloud
If you need to customize the Redis configurations for any of the Redis modules and providers, you must host and manage your own Redis instance externally.
If you need to customize the Redis configurations for any of the Redis modules and providers in your Cloud project, you must host and manage your own Redis instance externally.
Then, configure the modules and providers you're overriding in your `medusa-config.ts` file to connect to your external Redis instance. Refer to the documentation for each module for more details on how to configure it.

16
www/apps/cloud/app/s3/page.mdx
View File

@@ -4,11 +4,11 @@ export const metadata = {
# {metadata.title}
In this guide, you'll learn about the managed S3 storage service that Medusa provides as part of your project environments.
In this guide, you'll learn about the managed S3 storage service that Medusa provides as part of your project environments on Cloud.
## Managed S3 Storage Service
## Managed S3 Storage Service on Cloud
Medusa offers a managed S3 storage service for your project environments. Each environment has its own dedicated S3 bucket that is automatically provisioned when the environment is created.
Medusa offers a managed S3 storage service for your project environments on Cloud. Each environment has its own dedicated S3 bucket that is automatically provisioned when the environment is created.
So, when you create a new project, Medusa creates a production S3 bucket for the production environment. If you create a staging environment, Medusa creates a separate S3 bucket for that environment as well.
@@ -18,9 +18,9 @@ By default, the S3 bucket is private, but the files you upload to the bucket are
---
## Configured S3 File Module Provider
## Configured S3 File Module Provider on Cloud
Medusa automatically configures your Medusa application to use the [S3 File Module Provider](!resources!/infrastructure-modules/file/s3).
Medusa automatically configures your Medusa application hosted on Cloud to use the [S3 File Module Provider](!resources!/infrastructure-modules/file/s3).
So, you don't need to configure the S3 File Module Provider or set up S3 manually. Also, if you have the S3 File Module Provider configured in `medusa-config.ts`, remove it to avoid conflicts.
@@ -30,13 +30,13 @@ If you're using a Medusa version before v2.7.0, contact support for assistance i
</Note>
### Access S3 Configurations
### Access S3 Configurations on Cloud
Since Cloud is a managed service, you can't directly access your S3 bucket or its configurations. Medusa also doesn't expose the S3 bucket connection or configuration details.
### Override S3 Configurations
### Override S3 Configurations on Cloud
If you need to override the default S3 configurations, such as changing public access to assets, you can do so by setting up and managing your own S3 bucket externally.
If you need to override the default S3 configurations of your Cloud project, such as changing public access to assets, you can do so by setting up and managing your own S3 bucket externally.
Then, configure the S3 File Module Provider in your `medusa-config.ts` file to connect to your external S3 instance. Refer to the [S3 File Module Provider documentation](!resources!/infrastructure-modules/file/s3) for more details on how to configure it.

10
www/apps/cloud/app/usage/page.mdx
View File

@@ -7,9 +7,9 @@ export const metadata = {
# {metadata.title}
In this guide, you'll learn how to monitor your organization's standard and Flex Usage in Cloud.
In this guide, you'll learn how to monitor your Cloud organization's standard and Flex Usage.
## View Usage
## View Usage on Cloud
In your organization's settings, you can view your current plan and usage limits.
@@ -40,7 +40,7 @@ To learn how your Flex Usage is billed, refer to the [Billing](../billing/page.m
### Monitor Flex Usage
You can view additional Flex Usage for each resource and its charge in the [usage table](#view-usage). The table has the following columns useful for monitoring Flex Usage:
You can view additional Flex Usage for each resource and its charge in the [usage table](#view-usage-on-cloud). The table has the following columns useful for monitoring Flex Usage:
- **Flex**: The amount of usage beyond your plan limits. For example, the additional data transfer amount.
- **Charge**: The cost associated with the Flex Usage.
@@ -49,7 +49,7 @@ If you have Flex Usage, you can also see the flex charges visualized in the char
---
## Download Usage Report
## Download Cloud Usage Report
To download your organization's usage as a JSON file:
@@ -65,7 +65,7 @@ The JSON file will be downloaded automatically.
## View Usage for Different Date Ranges
By default, the usage table and Flex Usage chart show data for the current billing cycle.
By default, the usage table and Flex Usage chart show data for the current billing cycle on Cloud.
To view usage for a different billing cycle, click on the "Current billing cycle" dropdown at the top of the Usage settings. You can then select the previous billing cycle, or a custom date range.

24
www/apps/cloud/generated/edit-dates.mjs
View File

@@ -2,23 +2,23 @@ export const generatedEditDates = {
"app/page.mdx": "2025-09-11T15:21:38.987Z",
"app/organization/page.mdx": "2025-06-12T14:43:20.772Z",
"app/projects/page.mdx": "2025-10-02T11:49:21.541Z",
"app/environments/page.mdx": "2025-06-25T08:00:05.550Z",
"app/deployments/page.mdx": "2025-10-02T13:45:55.265Z",
"app/environments/page.mdx": "2025-10-15T15:25:09.940Z",
"app/deployments/page.mdx": "2025-10-15T15:23:16.572Z",
"app/organizations/page.mdx": "2025-10-02T11:31:07.315Z",
"app/notifications/page.mdx": "2025-06-25T07:27:37.642Z",
"app/database/page.mdx": "2025-08-15T15:30:37.814Z",
"app/redis/page.mdx": "2025-06-25T07:57:23.246Z",
"app/s3/page.mdx": "2025-06-25T07:57:24.832Z",
"app/loyalty-plugin/page.mdx": "2025-06-26T11:11:02.320Z",
"app/logs/page.mdx": "2025-06-19T07:44:38.336Z",
"app/notifications/page.mdx": "2025-10-15T15:25:33.672Z",
"app/database/page.mdx": "2025-10-15T15:20:06.292Z",
"app/redis/page.mdx": "2025-10-15T15:22:34.997Z",
"app/s3/page.mdx": "2025-10-15T15:23:02.835Z",
"app/loyalty-plugin/page.mdx": "2025-10-15T15:27:40.303Z",
"app/logs/page.mdx": "2025-10-15T15:24:53.277Z",
"app/update-medusa/page.mdx": "2025-06-25T07:57:30.170Z",
"app/connect-storefront/page.mdx": "2025-06-25T07:47:00.499Z",
"app/environments/environment-variables/page.mdx": "2025-08-15T15:35:24.085Z",
"app/environments/long-lived/page.mdx": "2025-10-02T11:58:36.623Z",
"app/environments/preview/page.mdx": "2025-10-02T13:06:32.356Z",
"app/environments/environment-variables/page.mdx": "2025-10-15T15:26:47.364Z",
"app/environments/long-lived/page.mdx": "2025-10-15T15:27:08.743Z",
"app/environments/preview/page.mdx": "2025-10-15T15:19:02.671Z",
"app/faq/page.mdx": "2025-10-08T14:43:21.930Z",
"app/billing/page.mdx": "2025-10-08T14:37:11.611Z",
"app/usage/page.mdx": "2025-08-25T07:25:54.703Z",
"app/usage/page.mdx": "2025-10-15T15:26:16.696Z",
"app/billing/manage/page.mdx": "2025-10-08T14:40:23.629Z",
"app/pricing/page.mdx": "2025-09-05T10:31:59.059Z",
"app/sign-up/page.mdx": "2025-10-08T14:40:47.993Z",