docs: remove dev notices + fix AI assistant answer width (#9686)
* docs: remove dev notices + fix AI assistant answer width * fix import * more notes removal * rc to latest
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
8891c0a3d0
commit
c08df5ac44
35 files changed
+120
-332
No files matched your search
@@ -12,14 +12,6 @@ export const metadata = {
|
||||
|
||||
In this document, you’ll learn how to deploy the Medusa Admin to [Vercel](https://vercel.com).
|
||||
|
||||
<Note title="Important">
|
||||
|
||||
As Medusa v2 is still in active development, it's highly recommended not to deploy it for production purposes. The deployment process may also change.
|
||||
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
<Prerequisites items={[
|
||||
{
|
||||
text: "Medusa application’s codebase hosted on GitHub repository.",
|
||||
|
||||
@@ -3,7 +3,6 @@ sidebar_label: "Railway"
|
||||
---
|
||||
|
||||
import { Prerequisites, DetailsList } from "docs-ui"
|
||||
import OutdatedPreviewContent from "../../../troubleshooting/_sections/common-installation-errors/outdated-preview.mdx"
|
||||
|
||||
export const metadata = {
|
||||
title: `Deploy Medusa Application to Railway`,
|
||||
@@ -13,12 +12,6 @@ export const metadata = {
|
||||
|
||||
In this document, you’ll learn how to deploy your Medusa application to [Railway](https://railway.app/).
|
||||
|
||||
<Note title="Important">
|
||||
|
||||
As Medusa v2 is still in active development, it's highly recommended not to deploy it for production purposes.
|
||||
|
||||
</Note>
|
||||
|
||||
## What You’ll Deploy
|
||||
|
||||
1. PostgreSQL database.
|
||||
@@ -405,12 +398,3 @@ To check issues or errors in your deployed Medusa application:
|
||||
1. Click on the card of the Medusa application in server mode.
|
||||
2. Click on the Deployments tab.
|
||||
3. Click on the View Logs button.
|
||||
|
||||
<DetailsList
|
||||
sections={[
|
||||
{
|
||||
title: "Dependencies Using Outdated Preview Version",
|
||||
content: <OutdatedPreviewContent />
|
||||
}
|
||||
]}
|
||||
/>
|
||||
@@ -6,10 +6,4 @@ export const metadata = {
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
<Note title="Important">
|
||||
|
||||
As Medusa v2 is still in active development, it's highly recommended not to deploy it for production purposes.
|
||||
|
||||
</Note>
|
||||
|
||||
<ChildDocs />
|
||||
@@ -12,14 +12,6 @@ export const metadata = {
|
||||
|
||||
In this document, you’ll learn how to deploy the Next.js storefront to [Vercel](https://vercel.com).
|
||||
|
||||
<Note title="Important">
|
||||
|
||||
As Medusa v2 is still in active development, it's highly recommended not to deploy it for production purposes. The deployment process may also change.
|
||||
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
<Prerequisites items={[
|
||||
{
|
||||
text: "Storefront codebase hosted in a GitHub repository.",
|
||||
|
||||
@@ -21,7 +21,7 @@ The Medusa JS SDK is available in your Medusa application by default. So, you do
|
||||
To install the Medusa JS SDK in other projects, such as a custom storefront, run the following command:
|
||||
|
||||
```bash npm2yarn
|
||||
npm install @medusajs/js-sdk@rc @medusajs/types@rc
|
||||
npm install @medusajs/js-sdk@latest @medusajs/types@latest
|
||||
```
|
||||
|
||||
You install two libraries:
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { DetailsList, BetaBadge, Prerequisites } from "docs-ui"
|
||||
import { DetailsList, Prerequisites } from "docs-ui"
|
||||
import CmaOptionTroubleshooting from "../troubleshooting/_sections/nextjs/cma-option.mdx"
|
||||
import CorsErrorTroubleshooting from "../troubleshooting/_sections/other/cors-errors.mdx"
|
||||
import ModuleXErrorTroubleshooting from "../troubleshooting/_sections/common-installation-errors/module-x-error.mdx"
|
||||
@@ -7,7 +7,7 @@ export const metadata = {
|
||||
title: `Next.js Starter`,
|
||||
}
|
||||
|
||||
# {metadata.title} <BetaBadge text="Beta" tooltipText="Next.js starter is currently in development and doesn't fully support Medusa v2 yet." />
|
||||
# {metadata.title}
|
||||
|
||||
The Next.js Starter storefront provides rich commerce features and a sleek design. Developers and businesses can use it as-is or as a starting point to build a storefront for their Medusa application.
|
||||
|
||||
@@ -23,26 +23,6 @@ The Next.js Starter storefront provides rich commerce features and a sleek desig
|
||||
|
||||
## Installation
|
||||
|
||||
{/* TODO add when we support next.js starter in create-medusa-app v2 */}
|
||||
|
||||
{/* ### Option 1: Medusa Application + Next.js Starter
|
||||
|
||||
The `create-medusa-app` CLI tool accepts the `--with-nextjs-starter` option that installs the Next.js storefront along with the Medusa application:
|
||||
|
||||
```bash
|
||||
npx create-medusa-app@latest --with-nextjs-starter
|
||||
```
|
||||
|
||||
Refer to the [create-medusa-app reference](../create-medusa-app/page.mdx) for more details on prerequisites, steps, and troubleshooting. */}
|
||||
|
||||
{/* ### Option 2: Next.js Starter Only */}
|
||||
|
||||
{/* <Note type="check">
|
||||
|
||||
- At least one region in the Medusa application.
|
||||
|
||||
</Note> */}
|
||||
|
||||
1. Clone the `v2` branch of the [Next.js Starter](https://github.com/medusajs/nextjs-starter-medusa):
|
||||
|
||||
```bash
|
||||
|
||||
@@ -5,7 +5,7 @@ export const metadata = {
|
||||
title: `B2B Recipe`,
|
||||
}
|
||||
|
||||
# {metadata.title} <BetaBadge text="Soon" tooltipText="This recipe is a work in progress, as some features are not ready yet in Medusa V2." />
|
||||
# {metadata.title} <BetaBadge text="Soon" tooltipText="This recipe is a work in progress." />
|
||||
|
||||
This recipe provides the general steps to implement a B2B store with Medusa.
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
import { AcademicCapSolid, BoltSolid } from "@medusajs/icons"
|
||||
import { LearningPath, BetaBadge } from "docs-ui"
|
||||
import { BetaBadge } from "docs-ui"
|
||||
|
||||
export const metadata = {
|
||||
title: `Commerce Automation Recipe`,
|
||||
}
|
||||
|
||||
# {metadata.title} <BetaBadge text="Soon" tooltipText="This recipe is a work in progress, as some features are not ready yet in Medusa V2." />
|
||||
# {metadata.title} <BetaBadge text="Soon" tooltipText="This recipe is a work in progress." />
|
||||
|
||||
This recipe provides the general steps to implement commerce automation with Medusa.
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ Medusa provides all essential commerce features out-of-the-box. Businesses can g
|
||||
Use the following command to install an ecommerce store with Medusa:
|
||||
|
||||
```bash
|
||||
npx create-medusa-app@rc --with-nextjs-starter
|
||||
npx create-medusa-app@latest --with-nextjs-starter
|
||||
```
|
||||
|
||||
This installs:
|
||||
|
||||
@@ -22,7 +22,7 @@ The `@medusajs/types` package provide API routes' request and response types.
|
||||
If you're not using the JS SDK, install `@medusajs/types` to use the correct request and response types:
|
||||
|
||||
```bash npm2yarn
|
||||
npm install @medusajs/types@rc
|
||||
npm install @medusajs/types@latest
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
-10
@@ -1,10 +0,0 @@
|
||||
If you've installed an `rc` version of a package, such as `@medusajs/medusa/file-s3`, make sure its version in `package.json` is set to `rc`:
|
||||
|
||||
```json title="package.json"
|
||||
"dependencies": {
|
||||
// ...
|
||||
"@medusajs/medusa/file-s3": "rc"
|
||||
}
|
||||
```
|
||||
|
||||
Otherwise, unexpected errors may occur when running the Medusa application due to outdated version installed.
|
||||
@@ -1,11 +0,0 @@
|
||||
import OutdatedPreviewContent from "../_sections/common-installation-errors/outdated-preview.mdx"
|
||||
|
||||
export const metadata = {
|
||||
title: `General Deployment Errors`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
## Dependencies Using Outdated Preview Version
|
||||
|
||||
<OutdatedPreviewContent />
|
||||
@@ -6,24 +6,4 @@ export const metadata = {
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
## Update Medusa Version
|
||||
|
||||
While Medusa v2 is still in active development, a version is released every three hours under the `rc` tag.
|
||||
|
||||
If you run into issues during your development, try first to remove the `node_modules` directory and `yarn.lock` file (or `package-lock.json`) and re-install the dependencies:
|
||||
|
||||
```bash
|
||||
rm -rf node_modules
|
||||
rm yarn.lock # or package-lock.json
|
||||
yarn install # or npm install
|
||||
```
|
||||
|
||||
This updates the Medusa v2 dependencies to the latest `rc` version, which may have resolved your issue.
|
||||
|
||||
If your issue still persists, check out the troubleshooting guides below or [create a GitHub issue](https://github.com/medusajs/medusa/issues/new?assignees=&labels=status:+needs+triaging,+version:+2.0&projects=&template=bug_report_v2.md&title=).
|
||||
|
||||
---
|
||||
|
||||
## Guides
|
||||
|
||||
<ChildDocs />
|
||||
@@ -1,5 +1,5 @@
|
||||
export const metadata = {
|
||||
title: `Troubleshooting Guides`,
|
||||
title: `Upgrade Guides`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
@@ -117,7 +117,7 @@ export const generatedEditDates = {
|
||||
"app/contribution-guidelines/docs/page.mdx": "2024-10-16T15:48:04.071Z",
|
||||
"app/create-medusa-app/page.mdx": "2024-08-05T11:10:55+03:00",
|
||||
"app/deployment/admin/vercel/page.mdx": "2024-10-16T08:10:29.377Z",
|
||||
"app/deployment/medusa-application/railway/page.mdx": "2024-10-15T12:50:50.981Z",
|
||||
"app/deployment/medusa-application/railway/page.mdx": "2024-10-22T11:02:09.029Z",
|
||||
"app/deployment/storefront/vercel/page.mdx": "2024-07-26T07:21:31+00:00",
|
||||
"app/deployment/page.mdx": "2024-07-25T09:55:22+03:00",
|
||||
"app/integrations/page.mdx": "2024-10-15T12:26:39.839Z",
|
||||
@@ -129,7 +129,7 @@ export const generatedEditDates = {
|
||||
"app/recipes/commerce-automation/page.mdx": "2024-10-16T08:52:01.585Z",
|
||||
"app/recipes/digital-products/examples/standard/page.mdx": "2024-10-16T08:52:12.991Z",
|
||||
"app/recipes/digital-products/page.mdx": "2024-10-03T13:07:44.147Z",
|
||||
"app/recipes/ecommerce/page.mdx": "2024-06-09T15:18:43+02:00",
|
||||
"app/recipes/ecommerce/page.mdx": "2024-10-22T11:01:01.218Z",
|
||||
"app/recipes/integrate-ecommerce-stack/page.mdx": "2024-10-16T08:52:16.760Z",
|
||||
"app/recipes/marketplace/examples/vendors/page.mdx": "2024-10-16T08:52:24.906Z",
|
||||
"app/recipes/marketplace/page.mdx": "2024-10-03T13:07:44.153Z",
|
||||
@@ -193,7 +193,7 @@ export const generatedEditDates = {
|
||||
"app/storefront-development/regions/list/page.mdx": "2024-09-11T10:07:34.742Z",
|
||||
"app/storefront-development/regions/store-retrieve-region/page.mdx": "2024-09-11T10:07:42.887Z",
|
||||
"app/storefront-development/regions/page.mdx": "2024-06-09T15:19:09+02:00",
|
||||
"app/storefront-development/tips/page.mdx": "2024-10-16T12:44:31.781Z",
|
||||
"app/storefront-development/tips/page.mdx": "2024-10-22T11:01:01.298Z",
|
||||
"app/storefront-development/page.mdx": "2024-06-09T15:19:09+02:00",
|
||||
"app/troubleshooting/cors-errors/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/troubleshooting/create-medusa-app-errors/page.mdx": "2024-07-11T10:29:13+03:00",
|
||||
@@ -238,7 +238,6 @@ export const generatedEditDates = {
|
||||
"app/admin-widget-injection-zones/page.mdx": "2024-09-30T08:43:53.147Z",
|
||||
"app/architectural-modules/notification/page.mdx": "2024-10-15T12:51:28.735Z",
|
||||
"app/architectural-modules/event/create/page.mdx": "2024-10-16T08:51:41.334Z",
|
||||
"app/troubleshooting/deployment/page.mdx": "2024-08-19T07:19:40.924Z",
|
||||
"references/core_flows/Order/functions/core_flows.Order.orderEditUpdateItemQuantityValidationStep/page.mdx": "2024-08-20T00:10:58.913Z",
|
||||
"references/core_flows/Order/functions/core_flows.Order.orderEditUpdateItemQuantityWorkflow/page.mdx": "2024-08-20T00:10:58.949Z",
|
||||
"references/core_flows/Order/functions/core_flows.Order.updateOrderEditItemQuantityValidationStep/page.mdx": "2024-08-20T00:10:59.121Z",
|
||||
|
||||
@@ -979,10 +979,6 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/app/troubleshooting/database-errors/page.mdx",
|
||||
"pathname": "/troubleshooting/database-errors"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/app/troubleshooting/deployment/page.mdx",
|
||||
"pathname": "/troubleshooting/deployment"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/app/troubleshooting/dist-imports/page.mdx",
|
||||
"pathname": "/troubleshooting/dist-imports"
|
||||
|
||||
@@ -9250,14 +9250,6 @@ export const generatedSidebar = [
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"path": "/troubleshooting/deployment",
|
||||
"title": "Deployment",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -2212,11 +2212,6 @@ export const sidebar = sidebarAttachHrefCommonOptions([
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/troubleshooting/deployment",
|
||||
title: "Deployment",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
|
||||
Reference in new issue
Block a user