From d22569f3797a0be941f8606f4699d5582acff687 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Fri, 21 Jul 2023 15:36:08 +0300 Subject: [PATCH] docs: added troubleshooting guide for beta version (#4582) * docs: added troubleshooting guide for beta version * Update docs/content/troubleshooting/upgrade-beta.md Co-authored-by: Rares Stefan --------- Co-authored-by: Rares Stefan --- docs/content/troubleshooting/upgrade-beta.md | 11 + www/docs/sidebars.js | 247 +++++++++++-------- 2 files changed, 149 insertions(+), 109 deletions(-) create mode 100644 docs/content/troubleshooting/upgrade-beta.md diff --git a/docs/content/troubleshooting/upgrade-beta.md b/docs/content/troubleshooting/upgrade-beta.md new file mode 100644 index 0000000000..93bc5c3f15 --- /dev/null +++ b/docs/content/troubleshooting/upgrade-beta.md @@ -0,0 +1,11 @@ +--- +title: 'Upgrading Beta Versions' +--- + +If you're using `beta` versions of Medusa packages, such as the `@medusajs/medusa` or `@medusajs/admin` packages, simply updating to the latest `beta` version might not work and you'll end up with the same version. This could be due to the version in `yarn.lock` or `package-lock.json` not updating properly. + +To resolve this issue, try the following: + +- Remove the `yarn.lock` or `package-lock.json` file in your project. +- Remove the `node_modules` directory +- Install again. diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index 096a8aa84e..fe68be4a7a 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -325,119 +325,12 @@ module.exports = { className: "homepage-sidebar-item", }, { - type: "category", + type: "ref", + id: "troubleshooting/create-medusa-app-errors", label: "Troubleshooting", customProps: { sidebar_icon: "bug", }, - items: [ - { - type: "category", - label: "Installation Errors", - items: [ - { - type: "doc", - id: "troubleshooting/create-medusa-app-errors", - label: "Create Medusa App Errors", - }, - { - type: "doc", - id: "troubleshooting/cli-installation-errors", - label: "Errors Installing CLI", - }, - { - type: "doc", - id: "troubleshooting/common-installation-errors", - label: "General Errors", - }, - { - type: "doc", - id: "troubleshooting/errors-after-update", - label: "Errors After Update", - }, - ], - }, - { - type: "category", - label: "Medusa Backend Errors", - items: [ - { - type: "doc", - id: "troubleshooting/eaddrinuse", - label: "EADDRINUSE Error", - }, - { - type: "doc", - id: "troubleshooting/database-error", - label: "Database SASL Error", - }, - { - type: "doc", - id: "troubleshooting/redis-events", - label: "Redis not emitting events", - }, - { - type: "doc", - id: "troubleshooting/awilix-resolution-error", - label: "Handling AwilixResolutionError", - }, - { - type: "doc", - id: "troubleshooting/missing-payment-providers", - label: "Payment provider missing", - }, - ], - }, - { - type: "category", - label: "Frontend Errors", - items: [ - { - type: "doc", - id: "troubleshooting/cors-issues", - label: "CORS issues", - }, - ], - }, - { - type: "category", - label: "Admin Dashboard Errors", - items: [ - { - type: "doc", - id: "troubleshooting/signing-in-to-admin", - label: "Signing in to the Admin Dashboard", - }, - { - type: "doc", - id: "troubleshooting/custom-hooks-error", - label: "Custom Hooks Error", - }, - ], - }, - { - type: "category", - label: "Plugin Errors", - items: [ - { - type: "doc", - id: "troubleshooting/s3-acl-error", - label: "S3 Plugin ACL Error", - }, - ], - }, - { - type: "category", - label: "Other Errors", - items: [ - { - type: "doc", - id: "troubleshooting/documentation-error", - label: "Documentation Error", - }, - ], - }, - ], className: "homepage-sidebar-item", }, { @@ -1927,6 +1820,142 @@ module.exports = { ], }, ], + troubleshooting: [ + { + type: "ref", + id: "homepage", + label: "Back to home", + customProps: { + sidebar_is_back_link: true, + sidebar_icon: "back-arrow", + }, + }, + { + type: "html", + value: "Troubleshooting", + customProps: { + sidebar_is_title: true, + sidebar_icon: "bug", + }, + }, + { + type: "category", + label: "Installation", + items: [ + { + type: "doc", + id: "troubleshooting/create-medusa-app-errors", + label: "Create Medusa App Errors", + }, + { + type: "doc", + id: "troubleshooting/cli-installation-errors", + label: "Errors Installing CLI", + }, + { + type: "doc", + id: "troubleshooting/common-installation-errors", + label: "General Errors", + }, + { + type: "doc", + id: "troubleshooting/errors-after-update", + label: "Errors After Update", + }, + ], + }, + { + type: "category", + label: "Medusa Backend", + items: [ + { + type: "doc", + id: "troubleshooting/eaddrinuse", + label: "EADDRINUSE Error", + }, + { + type: "doc", + id: "troubleshooting/database-error", + label: "Database SASL Error", + }, + { + type: "doc", + id: "troubleshooting/redis-events", + label: "Redis not emitting events", + }, + { + type: "doc", + id: "troubleshooting/awilix-resolution-error", + label: "Handling AwilixResolutionError", + }, + { + type: "doc", + id: "troubleshooting/missing-payment-providers", + label: "Payment provider missing", + }, + ], + }, + { + type: "category", + label: "Upgrade", + items: [ + { + type: "doc", + id: "troubleshooting/upgrade-beta", + label: "Upgrading Beta Versions", + }, + ], + }, + { + type: "category", + label: "Frontend", + items: [ + { + type: "doc", + id: "troubleshooting/cors-issues", + label: "CORS issues", + }, + ], + }, + { + type: "category", + label: "Admin Dashboard", + items: [ + { + type: "doc", + id: "troubleshooting/signing-in-to-admin", + label: "Signing in to the Admin Dashboard", + }, + { + type: "doc", + id: "troubleshooting/custom-hooks-error", + label: "Custom Hooks Error", + }, + ], + }, + { + type: "category", + label: "Plugin", + items: [ + { + type: "doc", + id: "troubleshooting/s3-acl-error", + label: "S3 Plugin ACL Error", + }, + ], + }, + { + type: "category", + label: "Other", + items: [ + { + type: "doc", + id: "troubleshooting/documentation-error", + label: "Documentation Error", + }, + ], + }, + ], plugins: [ { type: "ref",