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

docs: prep for v2 documentation (#6710)

Browse Source 
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs).

_Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._

## Changes

- Change Medusa version in base OAS used for v2.
- Fix to docblock generator related to not catching all path parameters.
- Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules.
- Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used.
- Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment.
- Upgraded docusaurus to v3.0.1
- Added new Vale rules to ensure correct spelling of Medusa Admin and module names.
- Added new components to the `docs-ui` package that will be used in future documentation changes.
This commit is contained in:
Shahed Nasser
2024-03-18 07:47:35 +00:00
committed by GitHub
parent 56a6ec0227
commit bb87db8342
2008 changed files with 15716 additions and 10536 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/deployments/admin/general-guide.mdx
+2 -2
View File
@@ -8,7 +8,7 @@ import CorsErrorSection from '../../troubleshooting/cors-issues.md'
# General Deployment Guide for Medusa Admin
In this guide, you’ll learn the general steps to follow when deploying the Medusa admin separately from the backend. This guide isn’t tailored towards any hosting provider.
In this guide, you’ll learn the general steps to follow when deploying the Medusa Admin separately from the backend. This guide isn’t tailored towards any hosting provider.
## Prerequisites
@@ -69,7 +69,7 @@ When using the `--deployment` option, the backend's URL is loaded from the `MEDU
The steps to deploy the admin can be different based on the hosting provider you use. The following points cover common configurations across hosting providers:
- If your hosting provider supports choosing a Framework Preset, choose the “Other” option as the Medusa admin doesn’t follow known framework presets.
- If your hosting provider supports choosing a Framework Preset, choose the “Other” option as the Medusa Admin doesn’t follow known framework presets.
- Set the build command of your deployed project to use the `build:admin` command:
```bash npm2yarn
www/apps/docs/content/deployments/index.mdx
+4 -4
View File
@@ -14,7 +14,7 @@ In this document, you’ll learn about the different ways you can deploy your Me
A standard Medusa project is made up of the following:
- Medusa backend
- Medusa admin
- Medusa Admin
- One or more storefronts
![Diagram showcasing the connection between the three deployed components](https://res.cloudinary.com/dza7lstvk/image/upload/v1705999238/Medusa%20Docs/Diagrams/Social_Media_Graphics_2024_options_uxzmlx.jpg)
@@ -27,7 +27,7 @@ This guide details options to consider when deploying each of these components i
You must deploy the Medusa backend before the admin or storefront, as both of them connect to the backend and won’t work without a deployed Medusa backend URL.
![Diagram showcasing how the Medusa admin and its associated services would be deployed](https://res.cloudinary.com/dza7lstvk/image/upload/v1705999287/Medusa%20Docs/Diagrams/Social_Media_Graphics_2024_backend_deployment__1_twbdsd.jpg)
![Diagram showcasing how the Medusa Admin and its associated services would be deployed](https://res.cloudinary.com/dza7lstvk/image/upload/v1705999287/Medusa%20Docs/Diagrams/Social_Media_Graphics_2024_backend_deployment__1_twbdsd.jpg)
The Medusa backend is a Node.js server. So, it must be deployed to a hosting provider that supports deploying servers, such as Railway, DigitalOcean, AWS, Heroku, etc…
@@ -49,11 +49,11 @@ Your backend connects to PostgreSQL and Redis databases. Most hosting providers
## Deploying the Medusa Admin
There are two options to deploy the Medusa admin:
There are two options to deploy the Medusa Admin:
### Deploy Admin with Backend
Since the Medusa admin is a plugin installed in the backend, you may choose to host it along with the backend.
Since the Medusa Admin is a plugin installed in the backend, you may choose to host it along with the backend.
In this scenario, make sure the hosting provider and plan of your choice provide at least 2GB of RAM, as the admin build requires high RAM usage.
www/apps/docs/content/deployments/server/deploying-on-heroku.mdx
+2 -2
View File
@@ -366,7 +366,7 @@ For example, to create an admin user you can run the following command:
heroku run -a <APP_NAME> -- npx medusa user -e "<EMAIL>" -p "<PASSWORD>"
```
Where `<APP_NAME>` is the name of your Heroku app, and `<EMAIL>` and `<PASSWORD>` are the credentials you want to use to log in to the Medusa admin dashboard.
Where `<APP_NAME>` is the name of your Heroku app, and `<EMAIL>` and `<PASSWORD>` are the credentials you want to use to log in to the Medusa Admin dashboard.
---
@@ -386,5 +386,5 @@ Where `<APP_NAME>` is the name of your Heroku app, `<ENV_NAME>` is the name of t
## See Also
- [Deploy your Medusa admin](../admin/index.mdx)
- [Deploy your Medusa Admin](../admin/index.mdx)
- [Deploy your storefront](../storefront/index.mdx)
www/apps/docs/content/deployments/server/deploying-on-railway.md
+1 -1
View File
@@ -234,7 +234,7 @@ It’s highly recommended to use strong, randomly generated secrets for `JWT_SE
:::
Make sure to add any other environment variables that are relevant for you here. For example, you can add environment variables related to Medusa admin or your modules.
Make sure to add any other environment variables that are relevant for you here. For example, you can add environment variables related to Medusa Admin or your modules.
### Change Start Command