docs: added troubleshooting docs (#2900)

This commit is contained in:
Shahed Nasser
2022-12-26 16:19:10 +02:00
committed by GitHub
parent b0ebfd6bcf
commit 2916ff9861
6 changed files with 75 additions and 0 deletions

View File

@@ -66,6 +66,12 @@ npm install
negativeQuestion="Please describe the issue you faced."
/>
:::tip
If you run into errors during the installation, check out [this troubleshooting guide](../troubleshooting/common-installation-errors.mdx).
:::
---
## Test it Out

View File

@@ -64,6 +64,12 @@ Your Gatsby storefront is now running at `localhost:8000`!
negativeQuestion="Please describe the issue you faced."
/>
:::tip
If you run into errors during the installation, check out [this troubleshooting guide](../troubleshooting/common-installation-errors.mdx).
:::
---
## Development Notes

View File

@@ -58,6 +58,12 @@ Your Next.js storefront is now running at `localhost:8000`!
negativeQuestion="Please describe the issue you faced."
/>
:::tip
If you run into errors during the installation, check out [this troubleshooting guide](../troubleshooting/common-installation-errors.mdx).
:::
---
## Development Notes

View File

@@ -0,0 +1,27 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Resolve "Cannot find module X" Errors
This error can occur while installing one of the storefronts or the Medusa admin. There is no specific cause to this error.
One way to resolve it is by removing the `node_modules` directory in the project and re-installing the dependencies:
<Tabs groupId="operating-systems" wrapperClassName="code-tabs">
<TabItem value="unix" label="MacOS / Linux" default>
```bash
rm -rf node_modules
yarn install
```
</TabItem>
<TabItem value="windows" label="Windows">
```bash
rd /s /q node_modules
yarn install
```
</TabItem>
</Tabs>

View File

@@ -0,0 +1,20 @@
# Error: SASL: SCRAM-SERVER-FIRST-MESSAGE: Client password must be a string
You can get the following error while running `medusa new` or while running integration tests during [local development](../usage/local-development.md):
```bash
Error: SASL: SCRAM-SERVER-FIRST-MESSAGE: client password must be a string
```
If the error occurs while running `medusa new` and you've selected to enter your database credentials, either:
1. Make sure your database credentials are correct;
2. Or choose the Skip option to skip entering your database credentials.
If the error occurs while running integration tests, make sure the following variable is set in your system's environment variable:
```bash
DB_HOST=<YOUR_DB_HOST>
DB_USERNAME=<YOUR_DB_USERNAME>
DB_PASSWORD=<YOUR_PASSWORD>
```

View File

@@ -622,6 +622,16 @@ module.exports = {
id: "troubleshooting/cli-installation-errors",
label: "Errors Installing CLI",
},
{
type: "doc",
id: "troubleshooting/common-installation-errors",
label: "Installation Errors",
},
{
type: "doc",
id: "troubleshooting/database-error",
label: "Database SASL Error",
},
{
type: "doc",
id: "troubleshooting/cors-issues",