docs: editing and general fixes of medusa's learning resources (#7261)

* docs: editing and general fixes of medusa's learning resources

* fix build script

* update ui dependency

* fix build

* adjust next.js steps
This commit is contained in:
Shahed Nasser
2024-05-13 18:55:11 +03:00
committed by GitHub
parent 803e4aad02
commit 7cb90f8e82
79 changed files with 488 additions and 1707 deletions
@@ -4,6 +4,12 @@ export const metadata = {
# {metadata.title}
<Note type="soon">
The following deployment guide doesn't support Medusa v2 yet.
</Note>
In this guide, youll learn the general steps to follow when deploying the Medusa Admin separately from the Medusa application.
<Note type="check">
@@ -4,6 +4,12 @@ export const metadata = {
# {metadata.title}
<Note type="soon">
The following deployment guide doesn't support Medusa v2 yet.
</Note>
This guide explains how to deploy the Medusa Admin separately from the Medusa application to Vercel.
<Note title="Important">
@@ -4,6 +4,12 @@ export const metadata = {
# {metadata.title}
<Note type="soon">
The following deployment guide doesn't support Medusa v2 yet.
</Note>
[DigitalOcean](https://www.digitalocean.com/) is a reliable hosting provider that provides different ways to host websites and servers.
<Note type="check">
@@ -24,7 +30,7 @@ If you're using the Medusa Admin plugin, you have two options to deploy it: eith
To deploy the admin with the Medusa application:
1. Your chosen plan must offer at least 2GB of RAM.
2. Enable the [autoRebuild option](../../../configurations/medusa-admin/page.mdx#Plugin_Options-autoRebuild-1-1) of the admin plugin:
2. Enable the autoRebuild option of the admin plugin:
```js title="medusa-config.js" highlights={[["7"]]}
const plugins = [
@@ -44,7 +50,7 @@ Alternatively, you can use a GitHub action to build the admin as explained [here
### Deploying Separately
To deploy the admin separately, disable the admin plugin's [serve option](../../../configurations/medusa-admin/page.mdx#Plugin_Options-serve-1-0):
To deploy the admin separately, disable the admin plugin's serve option:
```js title="medusa-config.js" highlights={[["10"]]}
const plugins = [
@@ -4,6 +4,12 @@ export const metadata = {
# {metadata.title}
<Note type="soon">
The following deployment guide doesn't support Medusa v2 yet.
</Note>
In this guide, youll learn the general steps you need to take when deploying your Medusa application.
<Note type="check">
@@ -61,7 +67,7 @@ If you're using the Medusa Admin plugin, you have two options to deploy it: eith
To deploy the admin with the Medusa application:
1. Your chosen plan must offer at least 2GB of RAM.
2. Enable the [autoRebuild option](../../../configurations/medusa-admin/page.mdx#Plugin_Options-autoRebuild-1-1) of the admin plugin:
2. Enable the autoRebuild option of the admin plugin:
```js title="medusa-config.js" highlights={[["7"]]}
const plugins = [
@@ -81,7 +87,7 @@ Alternatively, you can use a GitHub action to build the admin as explained [here
### Deploying Separately
To deploy the admin separately, disable the admin plugin's [serve option](../../../configurations/medusa-admin/page.mdx#Plugin_Options-serve-1-0):
To deploy the admin separately, disable the admin plugin's serve option:
```js title="medusa-config.js" highlights={[["10"]]}
const plugins = [
@@ -4,6 +4,12 @@ export const metadata = {
# {metadata.title}
<Note type="soon">
The following deployment guide doesn't support Medusa v2 yet.
</Note>
[Heroku](https://www.heroku.com/) is a PaaS (Platform as a Service) that allows you to easily deploy your applications in the cloud.
Alternatively, you can use this button to deploy the Medusa application to Heroku directly:
@@ -31,7 +37,7 @@ If you're using the Medusa Admin plugin, you have two options to deploy it: eith
To deploy the Medusa Admin with the Medusa application:
1. Your chosen plan must offer at least 2GB of RAM.
2. Enable the [autoRebuild option](../../../configurations/medusa-admin/page.mdx#Plugin_Options-autoRebuild-1-1) of the admin plugin:
2. Enable the autoRebuild option of the admin plugin:
```js title="medusa-config.js" highlights={[["7"]]}
const plugins = [
@@ -51,7 +57,7 @@ Alternatively, you can use a GitHub action to build the admin as explained [here
### Deploying Separately
To deploy the admin separately, disable the admin plugin's [serve option](../../../configurations/medusa-admin/page.mdx#Plugin_Options-serve-1-0):
To deploy the admin separately, disable the admin plugin's serve option:
```js title="medusa-config.js" highlights={[["10"]]}
const plugins = [
@@ -4,6 +4,12 @@ export const metadata = {
# {metadata.title}
<Note type="soon">
The following deployment guide doesn't support Medusa v2 yet.
</Note>
<Note>
This guide was submitted through a community contribution.
@@ -53,7 +59,7 @@ If you're using the Medusa Admin plugin, you have two options to deploy it: eith
To deploy the admin with the Medusa application:
1. Your chosen plan must offer at least 2GB of RAM.
2. Enable the [autoRebuild option](../../../configurations/medusa-admin/page.mdx#Plugin_Options-autoRebuild-1-1) of the admin plugin:
2. Enable the autoRebuild option of the admin plugin:
```js title="medusa-config.js" highlights={[["7"]]}
const plugins = [
@@ -73,7 +79,7 @@ Alternatively, you can use a GitHub action to build the admin as explained [here
#### Deploying Separately
To deploy the admin separately, disable the admin plugin's [serve option](../../../configurations/medusa-admin/page.mdx#Plugin_Options-serve-1-0):
To deploy the admin separately, disable the admin plugin's serve option:
```js title="medusa-config.js" highlights={[["10"]]}
const plugins = [
@@ -4,6 +4,12 @@ export const metadata = {
# {metadata.title}
<Note type="soon">
The following deployment guide doesn't support Medusa v2 yet.
</Note>
[Railway](https://railway.app/) is a hosting provider that you can use to deploy web applications and databases without having to worry about managing the full infrastructure.
You can deploy a Medusa application to Railway instantly with this button:
@@ -31,7 +37,7 @@ If you're using the Medusa Admin plugin, you have two options to deploy it: eith
To deploy the admin with the Medusa application:
1. Your chosen plan must offer at least 2GB of RAM.
2. Enable the [autoRebuild option](../../../configurations/medusa-admin/page.mdx#Plugin_Options-autoRebuild-1-1) of the admin plugin:
2. Enable the autoRebuild option of the admin plugin:
```js title="medusa-config.js" highlights={[["7"]]}
const plugins = [
@@ -51,7 +57,7 @@ Alternatively, you can use a GitHub action to build the admin as explained [here
### Deploying Separately
To deploy the admin separately, disable the admin plugin's [serve option](../../../configurations/medusa-admin/page.mdx#Plugin_Options-serve-1-0):
To deploy the admin separately, disable the admin plugin's serve option:
```js title="medusa-config.js" highlights={[["10"]]}
const plugins = [
@@ -6,4 +6,10 @@ export const metadata = {
# {metadata.title}
<Note type="soon">
Deployment guides are coming soon for Medusa v2. The following guides are based on Medusa v1.
</Note>
<ChildDocs />
@@ -4,6 +4,12 @@ export const metadata = {
# {metadata.title}
<Note type="soon">
The following deployment guide doesn't support Medusa v2 yet.
</Note>
In this guide, youll learn the general steps to follow when deploying the Next.js Starter.
<Note type="check">
@@ -4,6 +4,12 @@ export const metadata = {
# {metadata.title}
<Note type="soon">
The following deployment guide doesn't support Medusa v2 yet.
</Note>
This guide explains how to deploy the Medusa Admin separately from the Medusa application to Vercel.
<Note title="Important">