diff --git a/www/apps/api-reference/package.json b/www/apps/api-reference/package.json index 8f420432e3..1a89dbc17f 100644 --- a/www/apps/api-reference/package.json +++ b/www/apps/api-reference/package.json @@ -16,7 +16,7 @@ "@mdx-js/loader": "^3.0.0", "@mdx-js/react": "^3.0.0", "@medusajs/icons": "^1.2.0", - "@medusajs/ui": "^2.4.1", + "@medusajs/ui": "^3.0.0", "@next/mdx": "14.2.3", "@readme/openapi-parser": "^2.5.0", "@types/mapbox__rehype-prism": "^0.8.0", diff --git a/www/apps/resources/app/plugins/analytics/segment/page.mdx b/www/apps/resources/app/_plugins/analytics/segment/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/analytics/segment/page.mdx rename to www/apps/resources/app/_plugins/analytics/segment/page.mdx diff --git a/www/apps/resources/app/plugins/cms/contentful/page.mdx b/www/apps/resources/app/_plugins/cms/contentful/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/cms/contentful/page.mdx rename to www/apps/resources/app/_plugins/cms/contentful/page.mdx diff --git a/www/apps/resources/app/plugins/cms/strapi/page.mdx b/www/apps/resources/app/_plugins/cms/strapi/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/cms/strapi/page.mdx rename to www/apps/resources/app/_plugins/cms/strapi/page.mdx diff --git a/www/apps/resources/app/plugins/erp/brightpearl/page.mdx b/www/apps/resources/app/_plugins/erp/brightpearl/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/erp/brightpearl/page.mdx rename to www/apps/resources/app/_plugins/erp/brightpearl/page.mdx diff --git a/www/apps/resources/app/plugins/fulfillment/manual/page.mdx b/www/apps/resources/app/_plugins/fulfillment/manual/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/fulfillment/manual/page.mdx rename to www/apps/resources/app/_plugins/fulfillment/manual/page.mdx diff --git a/www/apps/resources/app/plugins/fulfillment/webshipper/page.mdx b/www/apps/resources/app/_plugins/fulfillment/webshipper/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/fulfillment/webshipper/page.mdx rename to www/apps/resources/app/_plugins/fulfillment/webshipper/page.mdx diff --git a/www/apps/resources/app/plugins/notifications/mailchimp/page.mdx b/www/apps/resources/app/_plugins/notifications/mailchimp/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/notifications/mailchimp/page.mdx rename to www/apps/resources/app/_plugins/notifications/mailchimp/page.mdx diff --git a/www/apps/resources/app/plugins/notifications/sendgrid/page.mdx b/www/apps/resources/app/_plugins/notifications/sendgrid/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/notifications/sendgrid/page.mdx rename to www/apps/resources/app/_plugins/notifications/sendgrid/page.mdx diff --git a/www/apps/resources/app/plugins/notifications/slack/page.mdx b/www/apps/resources/app/_plugins/notifications/slack/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/notifications/slack/page.mdx rename to www/apps/resources/app/_plugins/notifications/slack/page.mdx diff --git a/www/apps/resources/app/plugins/notifications/twilio-sms/page.mdx b/www/apps/resources/app/_plugins/notifications/twilio-sms/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/notifications/twilio-sms/page.mdx rename to www/apps/resources/app/_plugins/notifications/twilio-sms/page.mdx diff --git a/www/apps/resources/app/plugins/other/discount-generator/page.mdx b/www/apps/resources/app/_plugins/other/discount-generator/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/other/discount-generator/page.mdx rename to www/apps/resources/app/_plugins/other/discount-generator/page.mdx diff --git a/www/apps/resources/app/plugins/other/ip-lookup/page.mdx b/www/apps/resources/app/_plugins/other/ip-lookup/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/other/ip-lookup/page.mdx rename to www/apps/resources/app/_plugins/other/ip-lookup/page.mdx diff --git a/www/apps/resources/app/plugins/other/restock-notifications/page.mdx b/www/apps/resources/app/_plugins/other/restock-notifications/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/other/restock-notifications/page.mdx rename to www/apps/resources/app/_plugins/other/restock-notifications/page.mdx diff --git a/www/apps/resources/app/plugins/other/wishlist/page.mdx b/www/apps/resources/app/_plugins/other/wishlist/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/other/wishlist/page.mdx rename to www/apps/resources/app/_plugins/other/wishlist/page.mdx diff --git a/www/apps/resources/app/plugins/page.mdx b/www/apps/resources/app/_plugins/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/page.mdx rename to www/apps/resources/app/_plugins/page.mdx diff --git a/www/apps/resources/app/plugins/payment/klarna/page.mdx b/www/apps/resources/app/_plugins/payment/klarna/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/payment/klarna/page.mdx rename to www/apps/resources/app/_plugins/payment/klarna/page.mdx diff --git a/www/apps/resources/app/plugins/payment/paypal/page.mdx b/www/apps/resources/app/_plugins/payment/paypal/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/payment/paypal/page.mdx rename to www/apps/resources/app/_plugins/payment/paypal/page.mdx diff --git a/www/apps/resources/app/plugins/payment/stripe/page.mdx b/www/apps/resources/app/_plugins/payment/stripe/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/payment/stripe/page.mdx rename to www/apps/resources/app/_plugins/payment/stripe/page.mdx diff --git a/www/apps/resources/app/plugins/search/algolia/page.mdx b/www/apps/resources/app/_plugins/search/algolia/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/search/algolia/page.mdx rename to www/apps/resources/app/_plugins/search/algolia/page.mdx diff --git a/www/apps/resources/app/plugins/search/meilisearch/page.mdx b/www/apps/resources/app/_plugins/search/meilisearch/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/search/meilisearch/page.mdx rename to www/apps/resources/app/_plugins/search/meilisearch/page.mdx diff --git a/www/apps/resources/app/plugins/source/shopify/page.mdx b/www/apps/resources/app/_plugins/source/shopify/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/source/shopify/page.mdx rename to www/apps/resources/app/_plugins/source/shopify/page.mdx diff --git a/www/apps/resources/app/plugins/storage/local/page.mdx b/www/apps/resources/app/_plugins/storage/local/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/storage/local/page.mdx rename to www/apps/resources/app/_plugins/storage/local/page.mdx diff --git a/www/apps/resources/app/plugins/storage/minio/page.mdx b/www/apps/resources/app/_plugins/storage/minio/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/storage/minio/page.mdx rename to www/apps/resources/app/_plugins/storage/minio/page.mdx diff --git a/www/apps/resources/app/plugins/storage/s3/page.mdx b/www/apps/resources/app/_plugins/storage/s3/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/storage/s3/page.mdx rename to www/apps/resources/app/_plugins/storage/s3/page.mdx diff --git a/www/apps/resources/app/plugins/storage/spaces/page.mdx b/www/apps/resources/app/_plugins/storage/spaces/page.mdx similarity index 100% rename from www/apps/resources/app/plugins/storage/spaces/page.mdx rename to www/apps/resources/app/_plugins/storage/spaces/page.mdx diff --git a/www/apps/resources/app/recipes/b2b/page.mdx b/www/apps/resources/app/_recipes/b2b/page.mdx similarity index 100% rename from www/apps/resources/app/recipes/b2b/page.mdx rename to www/apps/resources/app/_recipes/b2b/page.mdx diff --git a/www/apps/resources/app/recipes/commerce-automation/page.mdx b/www/apps/resources/app/_recipes/commerce-automation/page.mdx similarity index 100% rename from www/apps/resources/app/recipes/commerce-automation/page.mdx rename to www/apps/resources/app/_recipes/commerce-automation/page.mdx diff --git a/www/apps/resources/app/recipes/digital-products/page.mdx b/www/apps/resources/app/_recipes/digital-products/page.mdx similarity index 100% rename from www/apps/resources/app/recipes/digital-products/page.mdx rename to www/apps/resources/app/_recipes/digital-products/page.mdx diff --git a/www/apps/resources/app/recipes/ecommerce/page.mdx b/www/apps/resources/app/_recipes/ecommerce/page.mdx similarity index 100% rename from www/apps/resources/app/recipes/ecommerce/page.mdx rename to www/apps/resources/app/_recipes/ecommerce/page.mdx diff --git a/www/apps/resources/app/recipes/integrate-ecommerce-stack/page.mdx b/www/apps/resources/app/_recipes/integrate-ecommerce-stack/page.mdx similarity index 100% rename from www/apps/resources/app/recipes/integrate-ecommerce-stack/page.mdx rename to www/apps/resources/app/_recipes/integrate-ecommerce-stack/page.mdx diff --git a/www/apps/resources/app/recipes/marketplace/page.mdx b/www/apps/resources/app/_recipes/marketplace/page.mdx similarity index 100% rename from www/apps/resources/app/recipes/marketplace/page.mdx rename to www/apps/resources/app/_recipes/marketplace/page.mdx diff --git a/www/apps/resources/app/recipes/multi-region-store/page.mdx b/www/apps/resources/app/_recipes/multi-region-store/page.mdx similarity index 100% rename from www/apps/resources/app/recipes/multi-region-store/page.mdx rename to www/apps/resources/app/_recipes/multi-region-store/page.mdx diff --git a/www/apps/resources/app/recipes/omnichannel/page.mdx b/www/apps/resources/app/_recipes/omnichannel/page.mdx similarity index 100% rename from www/apps/resources/app/recipes/omnichannel/page.mdx rename to www/apps/resources/app/_recipes/omnichannel/page.mdx diff --git a/www/apps/resources/app/recipes/oms/page.mdx b/www/apps/resources/app/_recipes/oms/page.mdx similarity index 100% rename from www/apps/resources/app/recipes/oms/page.mdx rename to www/apps/resources/app/_recipes/oms/page.mdx diff --git a/www/apps/resources/app/recipes/personalized-products/page.mdx b/www/apps/resources/app/_recipes/personalized-products/page.mdx similarity index 100% rename from www/apps/resources/app/recipes/personalized-products/page.mdx rename to www/apps/resources/app/_recipes/personalized-products/page.mdx diff --git a/www/apps/resources/app/recipes/pos/page.mdx b/www/apps/resources/app/_recipes/pos/page.mdx similarity index 100% rename from www/apps/resources/app/recipes/pos/page.mdx rename to www/apps/resources/app/_recipes/pos/page.mdx diff --git a/www/apps/resources/app/recipes/subscriptions/page.mdx b/www/apps/resources/app/_recipes/subscriptions/page.mdx similarity index 100% rename from www/apps/resources/app/recipes/subscriptions/page.mdx rename to www/apps/resources/app/_recipes/subscriptions/page.mdx diff --git a/www/apps/resources/app/admin-widget-injection-zones/page.mdx b/www/apps/resources/app/admin-widget-injection-zones/page.mdx index f28e27a356..d6dce003e8 100644 --- a/www/apps/resources/app/admin-widget-injection-zones/page.mdx +++ b/www/apps/resources/app/admin-widget-injection-zones/page.mdx @@ -6,6 +6,12 @@ export const metadata = { # {metadata.title} + + +Admin customizations are coming soon. + + + This documentation page includes the list of injection zones you can add Admin Widgets to. diff --git a/www/apps/resources/app/architectural-modules/cache/in-memory/page.mdx b/www/apps/resources/app/architectural-modules/cache/in-memory/page.mdx index 7f20976626..d891a038a7 100644 --- a/www/apps/resources/app/architectural-modules/cache/in-memory/page.mdx +++ b/www/apps/resources/app/architectural-modules/cache/in-memory/page.mdx @@ -25,11 +25,15 @@ npm install @medusajs/cache-inmemory Next, add the module into the `modules` property of the exported object in `medusa-config.js`: ```js title="medusa-config.js" +const { Modules } = require("@medusajs/modules-sdk") + +// ... + module.exports = { // ... modules: { // ... - cacheService: { + [Modules.CACHE]: { resolve: "@medusajs/cache-inmemory", options: { // optional options diff --git a/www/apps/resources/app/architectural-modules/cache/redis/page.mdx b/www/apps/resources/app/architectural-modules/cache/redis/page.mdx index f93aad9382..e94c01c71e 100644 --- a/www/apps/resources/app/architectural-modules/cache/redis/page.mdx +++ b/www/apps/resources/app/architectural-modules/cache/redis/page.mdx @@ -27,15 +27,19 @@ npm install @medusajs/cache-redis Next, add the module into the `modules` property of the exported object in `medusa-config.js`: export const highlights = [ - ["8", "redisUrl", "The Redis connection URL."] + ["12", "redisUrl", "The Redis connection URL."] ] ```js title="medusa-config.js" highlights={highlights} +const { Modules } = require("@medusajs/modules-sdk") + +// ... + module.exports = { // ... modules: { // ... - cacheService: { + [Modules.CACHE]: { resolve: "@medusajs/cache-redis", options: { redisUrl: process.env.CACHE_REDIS_URL, @@ -45,6 +49,14 @@ module.exports = { } ``` +### Environment Variables + +Make sure to add the following environment variables: + +```bash +CACHE_REDIS_URL= +``` + ### Redis Cache Module Options
@@ -148,14 +160,6 @@ module.exports = {
-### Environment Variables - -Make sure to add the following environment variables: - -```bash -CACHE_REDIS_URL= -``` - --- ## Test the Module diff --git a/www/apps/resources/app/architectural-modules/event/local/page.mdx b/www/apps/resources/app/architectural-modules/event/local/page.mdx index 9981988fb0..90a8e94d64 100644 --- a/www/apps/resources/app/architectural-modules/event/local/page.mdx +++ b/www/apps/resources/app/architectural-modules/event/local/page.mdx @@ -23,13 +23,15 @@ npm install @medusajs/event-local Next, add the module into the `modules` property of the exported object in `medusa-config.js`: ```js title="medusa-config.js" +const { Modules } = require("@medusajs/modules-sdk") + +// ... + module.exports = { // ... modules: { // ... - eventBus: { - resolve: "@medusajs/event-local", - }, + [Modules.EVENT_BUS]: true, }, } ``` diff --git a/www/apps/resources/app/architectural-modules/event/redis/page.mdx b/www/apps/resources/app/architectural-modules/event/redis/page.mdx index 0595ccdfa8..40157564ca 100644 --- a/www/apps/resources/app/architectural-modules/event/redis/page.mdx +++ b/www/apps/resources/app/architectural-modules/event/redis/page.mdx @@ -35,11 +35,15 @@ export const highlights = [ ] ```js title="medusa-config.js" +const { Modules } = require("@medusajs/modules-sdk") + +// ... + module.exports = { // ... modules: { // ... - eventBus: { + [Modules.EVENT_BUS]: { resolve: "@medusajs/event-redis", options: { redisUrl: process.env.EVENTS_REDIS_URL, @@ -49,6 +53,14 @@ module.exports = { } ``` +### Environment Variables + +Make sure to add the following environment variables: + +```bash +EVENTS_REDIS_URL= +``` + ### Redis Event Bus Module Options @@ -196,14 +208,6 @@ module.exports = {
-### Environment Variables - -Make sure to add the following environment variables: - -```bash -EVENTS_REDIS_URL= -``` - --- ## Test the Module diff --git a/www/apps/resources/app/architectural-modules/workflow-engine/redis/page.mdx b/www/apps/resources/app/architectural-modules/workflow-engine/redis/page.mdx index 7a0ee2ddc0..cc5fa4c923 100644 --- a/www/apps/resources/app/architectural-modules/workflow-engine/redis/page.mdx +++ b/www/apps/resources/app/architectural-modules/workflow-engine/redis/page.mdx @@ -51,6 +51,14 @@ module.exports = { } ``` +### Environment Variables + +Make sure to add the following environment variables: + +```bash +WE_REDIS_URL= +``` + ### Redis Workflow Engine Module Options @@ -157,14 +165,6 @@ module.exports = {
-### Environment Variables - -Make sure to add the following environment variables: - -```bash -WE_REDIS_URL= -``` - --- ## Test the Module diff --git a/www/apps/resources/app/commerce-modules/payment/payment-provider/stripe/page.mdx b/www/apps/resources/app/commerce-modules/payment/payment-provider/stripe/page.mdx index 11d9cc619f..ebba6e499a 100644 --- a/www/apps/resources/app/commerce-modules/payment/payment-provider/stripe/page.mdx +++ b/www/apps/resources/app/commerce-modules/payment/payment-provider/stripe/page.mdx @@ -65,6 +65,14 @@ const modules = { } ``` +### Environment Variables + +Make sure to add the necessary environment variables for the above options in `.env`: + +```bash +STRIPE_USD_API_KEY= +``` + ### Module Options @@ -173,14 +181,6 @@ const modules = {
-### Environment Variables - -Make sure to add the necessary environment variables for the above options in `.env`: - -```bash -STRIPE_USD_API_KEY= -``` - --- ## Use Provider diff --git a/www/apps/resources/app/configurations/medusa-admin/page.mdx b/www/apps/resources/app/configurations/_medusa-admin/page.mdx similarity index 100% rename from www/apps/resources/app/configurations/medusa-admin/page.mdx rename to www/apps/resources/app/configurations/_medusa-admin/page.mdx diff --git a/www/apps/resources/app/contribution-guidelines/admin-translations/page.mdx b/www/apps/resources/app/contribution-guidelines/_admin-translations/page.mdx similarity index 100% rename from www/apps/resources/app/contribution-guidelines/admin-translations/page.mdx rename to www/apps/resources/app/contribution-guidelines/_admin-translations/page.mdx diff --git a/www/apps/resources/app/contribution-guidelines/docs/page.mdx b/www/apps/resources/app/contribution-guidelines/docs/page.mdx index 5fd62e3a6d..18cf49007f 100644 --- a/www/apps/resources/app/contribution-guidelines/docs/page.mdx +++ b/www/apps/resources/app/contribution-guidelines/docs/page.mdx @@ -4,8 +4,6 @@ export const metadata = { # {metadata.title} -{/* TODO needs updating */} - Thank you for your interest in contributing to the documentation! You will be helping the open source community and other developers interested in learning more about Medusa and using it. @@ -21,16 +19,13 @@ Medusa's documentation projects are all part of the documentation yarn workspace The workspace has the following two directories: - `apps`: this directory holds the different documentation websites and projects. - - `docs`: includes the codebase for the Medusa Book. It's built with [Next.js 14](https://nextjs.org/). - - `resources`: includes the codebase for the Medusa Resources documentation. It's built with [Next.js 14](https://nextjs.org/). + - `book`: includes the codebase for the Medusa Book. It's built with [Next.js 14](https://nextjs.org/). + - `resources`: includes the codebase for the Medusa Learning Resources documentation. It's built with [Next.js 14](https://nextjs.org/). - `api-reference`: includes the codebase for the API reference website. It's built with [Next.js 14](https://nextjs.org/). - `ui`: includes the codebase for the Medusa UI documentation website. It's built with [Next.js 14](https://nextjs.org/). - `packages`: this directory holds the shared packages and components necessary for the development of the projects in the `apps` directory. - `docs-ui` includes the shared React components between the different apps. - - `eslint-config-docs` includes the shared ESLint configuration between the different apps and packages. - `remark-rehype-plugins` includes Remark and Rehype plugins used by the documentation projects. - - `tailwind` includes the shared Tailwind CSS configuration between the different apps and packages. - - `tsconfig` includes the shared TypeScript configuration between the different apps and packages. --- @@ -40,17 +35,15 @@ All documentation projects are built with Next.js. The content is writtin in MDX ### Medusa Book Content -The content of the Medusa Book is placed under the `www/apps/docs/app` directory. +The content of the Medusa Book is placed under the `www/apps/book/app` directory. -### Medusa Resources Content +### Medusa Learning Resources Content The content of the Medusa Resources documentation is placed under the `www/apps/resources/app` directory. -{/* TODO check info */} - -Documentation pages under the `www/apps/docs/content/references` directory are generated automatically from the source code under the `packages/medusa` directory. So, you can't directly make changes to them. Instead, you'll have to make changes to the comments in the original source code. +Documentation pages under the `www/apps/resources/references` directory are generated automatically from the source code under the `packages/medusa` directory. So, you can't directly make changes to them. Instead, you'll have to make changes to the comments in the original source code. @@ -58,21 +51,21 @@ Documentation pages under the `www/apps/docs/content/references` directory are g The API reference's content is split into two types: -1. Static content, which are the content related to getting started, expanding fields, and more. These are located in the [www/apps/api-reference/app/_mdx](https://github.com/medusajs/medusa/tree/develop/www/apps/api-reference/app/_mdx) directory. They are MDX files. -2. OpenAPI specs that are shown to developers when checking the reference of an API Route. These are automatically generated from comments on API Routes. So, if you find issues in them or want to make improvements, you have to find the API Routes under the [`packages/medusa/src/api`](https://github.com/medusajs/medusa/tree/develop/packages/medusa/src/api) directory and make changes to its comments. +1. Static content, which are the content related to getting started, expanding fields, and more. These are located in the `www/apps/api-reference/app/_mdx` directory. They are MDX files. +2. OpenAPI specs that are shown to developers when checking the reference of an API Route. These are generated from OpenApi Spec comments, which are under the `www/utils/generated/oas-output` directory. ### Medusa UI Documentation -The content of the Medusa UI documentation are located under the [www/apps/ui/src/content/docs](https://github.com/medusajs/medusa/tree/develop/www/apps/ui/src/content/docs) directory. They are MDX files. +The content of the Medusa UI documentation are located under the `www/apps/ui/src/content/docs` directory. They are MDX files. -The UI documentation also shows code examples, which you can find under the [www/apps/ui/src/examples](https://github.com/medusajs/medusa/tree/develop/www/apps/ui/src/examples) directory. +The UI documentation also shows code examples, which are under the `www/apps/ui/src/examples` directory. + +The UI component props are generated from the source code and placed into the `www/apps/ui/src/specs` directory. To contribute to these props and their comments, check the comments in the source code under the `packages/design-system/ui` directory. --- ## Style Guide -{/* TODO check link */} - When you contribute to the documentation content, make sure to follow the [documentation style guide](https://www.notion.so/Style-Guide-Docs-fad86dd1c5f84b48b145e959f36628e0). --- @@ -161,11 +154,9 @@ cd www/vale ./run-vale.sh ui src/content/docs error ``` -### VS Code Extension +{/* TODO need to enable MDX v1 comments first. */} -To facilitate writing documentation, you can optionally use the [Vale VS Code extension](https://github.com/errata-ai/vale-vscode). This will show you any errors in your documentation while writing it. - -### Linter Exceptions +{/* ### Linter Exceptions If it's needed to break some style guide rules in a document, you can wrap the parts that the linter shouldn't scan with the following comments in the `md` or `mdx` files: @@ -187,7 +178,7 @@ Medusa supports Node versions 14 and 16. ``` -If you use this in your PR, you must justify its usage. +If you use this in your PR, you must justify its usage. */} --- @@ -230,18 +221,14 @@ yarn install 2\. Run the turbo command in the `www` directory: ```bash -turbo run lint +yarn lint ``` This will fix any fixable errors, and show errors that require your action. -### ESLint Exceptions +{/* TODO need to enable MDX v1 comments first. */} -:::note - -These exceptions only work in the main documentation website. - -::: +{/* ### ESLint Exceptions If some code blocks have errors that can't or shouldn't be fixed, you can add the following command before the code block: @@ -269,10 +256,4 @@ console.log("This block can use semicolons"); ```js console.log("This block can't use semi colons") ``` -~~~ - ---- - -## Need Additional Help - -If you need any additional help while contributing, you can join Medusa's [Discord server](https://discord.gg/medusajs) and ask Medusa’s core team as well as the community any questions. +~~~ */} diff --git a/www/apps/resources/app/create-medusa-app/page.mdx b/www/apps/resources/app/create-medusa-app/page.mdx index 60ecd03bac..523783ac56 100644 --- a/www/apps/resources/app/create-medusa-app/page.mdx +++ b/www/apps/resources/app/create-medusa-app/page.mdx @@ -191,6 +191,40 @@ npx create-medusa-app@latest + + + + `--verbose` + + + + + Shows detailed logs. Useful when you're reporting an issue with the tool. + + + + + `false` + + + + + + + `--v2` + + + + + Installs Medusa v2, which is still not ready for production. + + + + + `false` + + + @@ -215,7 +249,7 @@ If the database already has the necessary migrations and you don't need the comm To connect to a Supabase database, use the `--db-url` option with its value being the connection URL to your Supabase database. For example: ```bash -npx create-medusa-app@latest --db-url postgresql://postgres:@.supabase.co:5432/postgres +npx create-medusa-app@latest --db-url "postgres://postgres.:@aws-0-eu-central-1.pooler.supabase.com:5432/postgres" ``` diff --git a/www/apps/resources/app/deployment/admin/general/page.mdx b/www/apps/resources/app/deployment/admin/general/page.mdx index 9929e1f0e3..f4c80946a4 100644 --- a/www/apps/resources/app/deployment/admin/general/page.mdx +++ b/www/apps/resources/app/deployment/admin/general/page.mdx @@ -4,6 +4,12 @@ export const metadata = { # {metadata.title} + + +The following deployment guide doesn't support Medusa v2 yet. + + + In this guide, you’ll learn the general steps to follow when deploying the Medusa Admin separately from the Medusa application. diff --git a/www/apps/resources/app/deployment/admin/vercel/page.mdx b/www/apps/resources/app/deployment/admin/vercel/page.mdx index bf40a74201..525c2df47e 100644 --- a/www/apps/resources/app/deployment/admin/vercel/page.mdx +++ b/www/apps/resources/app/deployment/admin/vercel/page.mdx @@ -4,6 +4,12 @@ export const metadata = { # {metadata.title} + + +The following deployment guide doesn't support Medusa v2 yet. + + + This guide explains how to deploy the Medusa Admin separately from the Medusa application to Vercel. diff --git a/www/apps/resources/app/deployment/medusa-application/digitalocean/page.mdx b/www/apps/resources/app/deployment/medusa-application/digitalocean/page.mdx index c491f73e26..59a7e0b5a1 100644 --- a/www/apps/resources/app/deployment/medusa-application/digitalocean/page.mdx +++ b/www/apps/resources/app/deployment/medusa-application/digitalocean/page.mdx @@ -4,6 +4,12 @@ export const metadata = { # {metadata.title} + + +The following deployment guide doesn't support Medusa v2 yet. + + + [DigitalOcean](https://www.digitalocean.com/) is a reliable hosting provider that provides different ways to host websites and servers. @@ -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 = [ diff --git a/www/apps/resources/app/deployment/medusa-application/general/page.mdx b/www/apps/resources/app/deployment/medusa-application/general/page.mdx index 84da095864..d7419e9ede 100644 --- a/www/apps/resources/app/deployment/medusa-application/general/page.mdx +++ b/www/apps/resources/app/deployment/medusa-application/general/page.mdx @@ -4,6 +4,12 @@ export const metadata = { # {metadata.title} + + +The following deployment guide doesn't support Medusa v2 yet. + + + In this guide, you’ll learn the general steps you need to take when deploying your Medusa application. @@ -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 = [ diff --git a/www/apps/resources/app/deployment/medusa-application/heroku/page.mdx b/www/apps/resources/app/deployment/medusa-application/heroku/page.mdx index 36a8ded685..f55dac0fce 100644 --- a/www/apps/resources/app/deployment/medusa-application/heroku/page.mdx +++ b/www/apps/resources/app/deployment/medusa-application/heroku/page.mdx @@ -4,6 +4,12 @@ export const metadata = { # {metadata.title} + + +The following deployment guide doesn't support Medusa v2 yet. + + + [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 = [ diff --git a/www/apps/resources/app/deployment/medusa-application/microtica/page.mdx b/www/apps/resources/app/deployment/medusa-application/microtica/page.mdx index ac547cc594..72475f67ea 100644 --- a/www/apps/resources/app/deployment/medusa-application/microtica/page.mdx +++ b/www/apps/resources/app/deployment/medusa-application/microtica/page.mdx @@ -4,6 +4,12 @@ export const metadata = { # {metadata.title} + + +The following deployment guide doesn't support Medusa v2 yet. + + + 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 = [ diff --git a/www/apps/resources/app/deployment/medusa-application/railway/page.mdx b/www/apps/resources/app/deployment/medusa-application/railway/page.mdx index 9b5452fd90..95bf8ad997 100644 --- a/www/apps/resources/app/deployment/medusa-application/railway/page.mdx +++ b/www/apps/resources/app/deployment/medusa-application/railway/page.mdx @@ -4,6 +4,12 @@ export const metadata = { # {metadata.title} + + +The following deployment guide doesn't support Medusa v2 yet. + + + [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 = [ diff --git a/www/apps/resources/app/deployment/page.mdx b/www/apps/resources/app/deployment/page.mdx index c74a496722..9ed2736719 100644 --- a/www/apps/resources/app/deployment/page.mdx +++ b/www/apps/resources/app/deployment/page.mdx @@ -6,4 +6,10 @@ export const metadata = { # {metadata.title} + + +Deployment guides are coming soon for Medusa v2. The following guides are based on Medusa v1. + + + \ No newline at end of file diff --git a/www/apps/resources/app/deployment/storefront/general/page.mdx b/www/apps/resources/app/deployment/storefront/general/page.mdx index 7bf8589726..4dfd6791c1 100644 --- a/www/apps/resources/app/deployment/storefront/general/page.mdx +++ b/www/apps/resources/app/deployment/storefront/general/page.mdx @@ -4,6 +4,12 @@ export const metadata = { # {metadata.title} + + +The following deployment guide doesn't support Medusa v2 yet. + + + In this guide, you’ll learn the general steps to follow when deploying the Next.js Starter. diff --git a/www/apps/resources/app/deployment/storefront/vercel/page.mdx b/www/apps/resources/app/deployment/storefront/vercel/page.mdx index df47d11c79..eb68df79cd 100644 --- a/www/apps/resources/app/deployment/storefront/vercel/page.mdx +++ b/www/apps/resources/app/deployment/storefront/vercel/page.mdx @@ -4,6 +4,12 @@ export const metadata = { # {metadata.title} + + +The following deployment guide doesn't support Medusa v2 yet. + + + This guide explains how to deploy the Medusa Admin separately from the Medusa application to Vercel. diff --git a/www/apps/resources/app/events-reference/page.mdx b/www/apps/resources/app/events-reference/page.mdx index 9b7a8ce6a8..6dcfcffcd2 100644 --- a/www/apps/resources/app/events-reference/page.mdx +++ b/www/apps/resources/app/events-reference/page.mdx @@ -6,6 +6,12 @@ export const metadata = { # {metadata.title} + + +These events aren't fully supported in Medusa v2 yet. + + + This documentation page includes the list of events emitted by the Medusa application and their expected data payload. ## Batch Jobs Events diff --git a/www/apps/resources/app/js-client/page.mdx b/www/apps/resources/app/js-client/page.mdx index ab270ac9bf..7a261384b7 100644 --- a/www/apps/resources/app/js-client/page.mdx +++ b/www/apps/resources/app/js-client/page.mdx @@ -6,6 +6,12 @@ export const metadata = { # {metadata.title} + + +Medusa JS Client doesn't support Medusa v2 yet. + + + The [Medusa JS Client](https://www.npmjs.com/package/@medusajs/medusa-js) provides easy access to the Medusa application's REST APIs within TypeScript or JavaScript frontend projects. For example, if you're creating a storefront with frameworks like Nuxt, you can send requests to the Medusa application using this client. diff --git a/www/apps/resources/app/medusa-cli/page.mdx b/www/apps/resources/app/medusa-cli/page.mdx index c739fa236c..bf6ad92c53 100644 --- a/www/apps/resources/app/medusa-cli/page.mdx +++ b/www/apps/resources/app/medusa-cli/page.mdx @@ -8,9 +8,16 @@ export const metadata = { The Medusa CLI tool provides commands that facilitate your development. + + +Medusa's CLI tool doesn't fully support Medusa v2 yet. + + + - [Node.js v16+](https://nodejs.org/en/download) +- [Git CLI tool](https://git-scm.com/downloads) @@ -204,6 +211,18 @@ medusa new [ []] The database host to use for database setup. + + + + + + `--v2` + + + + + Installs Medusa v2, which is still not ready for production. + diff --git a/www/apps/resources/app/medusa-container-resources/page.mdx b/www/apps/resources/app/medusa-container-resources/page.mdx index f5ee81f6fa..1d8dfdaf6e 100644 --- a/www/apps/resources/app/medusa-container-resources/page.mdx +++ b/www/apps/resources/app/medusa-container-resources/page.mdx @@ -26,11 +26,6 @@ This documentation page includes the list of resources registered in the Medusa Registration Name - - - - Lifetime - @@ -50,57 +45,6 @@ This documentation page includes the list of resources registered in the Medusa `configModule` - - - - \- - - - - - - - - Services - - - - - Services that extend the `TransactionBaseService` class. - - - - - Each service is registered under its camel-case name. For example, the `ProductService` is registered as `productService`. - - - - - Core services by default have the `SINGLETON` lifetime. However, some have a different lifetime which is indicated in this table. Custom services, including services in plugins, by default have the `SCOPED` lifetime, unless defined differently within the custom service. - - - - - - - - Entity Manager - - - - - An instance of Typeorm’s Entity Manager. - - - - - `manager` - - - - - \- - @@ -120,9 +64,22 @@ This documentation page includes the list of resources registered in the Medusa `logger` + + + - \- + Remote Query + + + + + The remote query function. + + + + + `remoteQuery` @@ -130,25 +87,17 @@ This documentation page includes the list of resources registered in the Medusa - Single Payment Processor + Remote Link - An instance of every payment processor that extends the `AbstractPaymentService` or the `AbstractPaymentProcessor` classes. + The remote link function. - Every payment processor is registered under two names: - - - Its camel-case name of the processor. For example, the `StripeProviderService` is registered as `stripeProviderService`. - - `pp_` followed by its identifier. For example, the `StripeProviderService` is registered as `pp_stripe`. - - - - - By default, it's `SINGLETON` unless defined differently within the payment processor service. + `remoteLink` @@ -156,501 +105,18 @@ This documentation page includes the list of resources registered in the Medusa - All Payment Processors + Modules' main services - An array of all payment processor that extend the `AbstractPaymentService` or `AbstractPaymentProcessor` class. + The main service of every module added in `medusa-config.js`. - `paymentProviders` - - - - - `paymentProviders` is `TRANSIENT`, and each item in it is `SINGLETON`. - - - - - - - - Single Fulfillment Provider - - - - - An instance of every fulfillment provider that extends the `FulfillmentService` class. - - - - - Every fulfillment provider is registered under two names: - - - Its camel-case name. For example, the `WebshipperFulfillmentService` is registered as `webshipperFulfillmentService`. - - `fp_` followed by its identifier. For example, the `WebshipperFulfillmentService` is registered as `fp_webshipper`. - - - - - By default, it's `SINGLETON` unless defined differently within the fulfillment provider service. - - - - - - - - All Fulfillment Providers - - - - - An array of all fulfillment providers that extend the `FulfillmentService` class. - - - - - `fulfillmentProviders` - - - - - `fulfillmentProviders` is `TRANSIENT`, and each item in it is `SINGLETON`. - - - - - - - - Single Notification Provider - - - - - An instance of every notification provider that extends the `AbstractNotificationService` or the `BaseNotificationService` classes. - - - - - Every notification provider is registered under two names: - - - Its camel-case name. For example, the `SendGridService` is registered as `sendGridService`. - - `noti_` followed by its identifier. For example, the `SendGridService` is registered as `noti_sendgrid`. - - - - - By default, it's `SINGLETON` unless defined differently within the notification provider service. - - - - - - - - All Notification Providers - - - - - An array of all notification providers that extend the `AbstractNotificationService` or the `BaseNotificationService` classes. - - - - - `notificationProviders` - - - - - `notificationProviders` is `TRANSIENT`, and each item in it is `SINGLETON`. - - - - - - - - File Service - - - - - An instance of the class that extends the `FileService` class, if any. - - - - - The file service is registered under two names: - - - Its camel-case name. For example, the `MinioService` is registered as `minioService`. - - `fileService` - - - - - By default, it's `SINGLETON` unless defined differently within the file service. - - - - - - - - Search Service - - - - - An instance of the class that extends the `AbstractSearchService` or the `SearchService` classes, if any. - - - - - The search service is registered under two names: - - - Its camel-case name. For example, the `AlgoliaService` is registered as `algoliaService`. - - `searchService` - - - - - By default, it's `SINGLETON` unless defined differently within the search service. - - - - - - - - Single Tax Provider - - - - - An instance of every tax provider that extends the `AbstractTaxService` class. - - - - - The tax provider is registered under two names: - - - Its camel-case name. - - `tp_` followed by its identifier. - - - - - By default, it's `SINGLETON` unless defined differently within the tax provider service. - - - - - - - - All Tax Providers - - - - - An array of every tax provider that extends the `AbstractTaxService` class. - - - - - `taxProviders` - - - - - `taxProviders` is `TRANSIENT`, and each item in it is `SINGLETON`. - - - - - - - - Oauth Services - - - - - An instance of every service that extends the `OauthService` class. - - - - - Each Oauth Service is registered under its camel-case name followed by `Oauth`. - - - - - By default, it's `SINGLETON` unless defined differently within the Oauth service. - - - - - - - - Feature Flag Router - - - - - An instance of the `FlagRouter`. This can be used to list feature flags, set a feature flag’s value, or check if they’re enabled. - - - - - `featureFlagRouter` - - - - - \- - - - - - - - - Redis - - - - - An instance of the Redis client. If Redis is not configured, a fake Redis client is registered. - - - - - `redisClient` - - - - - \- - - - - - - - - Single Entity - - - - - An instance of every entity. - - - - - Each entity is registered under its camel-case name followed by Model. For example, the `CustomerGroup` entity is stored under `customerGroupModel`. - - - - - \- - - - - - - - - All Entities - - - - - An array of all database entities that is passed to Typeorm when connecting to the database. - - - - - `db_entities` - - - - - \- - - - - - - - - Repositories - - - - - An instance of each repository. - - - - - Each repository is registered under its camel-case name. For example, `CustomerGroupRepository` is stored under `customerGroupRepository`. - - - - - \- - - - - - - - - Single Batch Job Strategy - - - - - An instance of every class extending the `AbstractBatchJobStrategy` class. - - - - - Each batch job strategy is registered under three names: - - - Its camel-case name. For example, `ProductImportStrategy` is registered as `productImportStrategy`. - - `batch_` followed by its identifier. For example, the `ProductImportStrategy` is registered under `batch_product-import-strategy`. - - `batchType_` followed by its batch job type. For example, the `ProductImportStrategy` is registered under `batchType_product-import`. - - - - - \- - - - - - - - - All Batch Job Strategies - - - - - An array of all classes extending the `AbstractBatchJobStrategy` abstract class. - - - - - `batchJobStrategies` - - - - - \- - - - - - - - - Tax Calculation Strategy - - - - - An instance of the class implementing the `ITaxCalculationStrategy` interface. - - - - - `taxCalculationStrategy` - - - - - \- - - - - - - - - Cart Completion Strategy - - - - - An instance of the class extending the `AbstractCartCompletionStrategy` class. - - - - - `cartCompletionStrategy` - - - - - \- - - - - - - - - Price Selection Strategy - - - - - An instance of the class implementing the `IPriceSelectionStrategy` interface. - - - - - `priceSelectionStrategy` - - - - - \- - - - - - - - - Strategies - - - - - An instance of strategies that aren’t of the specific types mentioned above and that are under the `strategies` directory. - - - - - Its camel-case name. - - - - - \- + - For custom modules, the registration name is the key of the module in the `modules` configuration. + - For Medusa's commerce modules, you can use the `ModuleRegistrationName` enum imported from `@medusajs/modules-sdk`. diff --git a/www/apps/resources/app/medusa-react/page.mdx b/www/apps/resources/app/medusa-react/page.mdx index dc6a0f8a40..10bea7f8a0 100644 --- a/www/apps/resources/app/medusa-react/page.mdx +++ b/www/apps/resources/app/medusa-react/page.mdx @@ -6,6 +6,12 @@ export const metadata = { # {metadata.title} + + +Medusa JS Client doesn't support Medusa v2 yet. + + + [Medusa React](https://www.npmjs.com/package/medusa-react) is a React library that provides a set of utilities and hooks for interacting seamlessly with the Medusa backend. For example, if you're creating a storefront with frameworks like Nuxt, you can send requests to the backend using this client. You can also use it in your Medusa Admin customizations. diff --git a/www/apps/resources/app/nextjs-starter/page.mdx b/www/apps/resources/app/nextjs-starter/page.mdx index 49e2d1a34d..f4a4be917f 100644 --- a/www/apps/resources/app/nextjs-starter/page.mdx +++ b/www/apps/resources/app/nextjs-starter/page.mdx @@ -9,17 +9,26 @@ export const metadata = { # {metadata.title} + + +Next.js starter is currently in development and doesn't fully support Medusa v2 yet. + + + 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. - [Node.js v18+](https://nodejs.org/en/download) +- At least one region in the Medusa application. ## Installation -### Option 1: Medusa Application + Next.js Starter +{/* 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: @@ -27,26 +36,27 @@ The `create-medusa-app` CLI tool accepts the `--with-nextjs-starter` option that 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. +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 +{/* ### Option 2: Next.js Starter Only */} - +{/* - At least one region in the Medusa application. - + */} -1. Create a new Next.js project using the [Next.js Starter's GitHub repository](https://github.com/medusajs/nextjs-starter-medusa): +1. Clone the `v2` branch of the [Next.js Starter](https://github.com/medusajs/nextjs-starter-medusa): ```bash -npx create-next-app -e https://github.com/medusajs/nextjs-starter-medusa my-medusa-storefront +git clone https://github.com/medusajs/nextjs-starter-medusa -b v2 my-medusa-storefront ``` -2. Change to the `my-medusa-storefront` directory and rename the template environment variable: +2. Change to the `my-medusa-storefront` directory, install the dependencies, and rename the template environment variable: -```bash +```bash npm2yarn cd my-medusa-storefront +npm install mv .env.template .env.local ``` @@ -85,11 +95,13 @@ The Next.js Starter storefront is compatible with Medusa's Stripe and PayPal plu ### Stripe Integration - +{/* TODO add links to stripe module once supported. */} + +{/* - [Stripe plugin](../plugins/payment/stripe/page.mdx) installed in the Medusa application. - + */} In your Next.js Starter project, set the following environment variables for the Stripe integration: @@ -103,11 +115,13 @@ Then, restart the Next.js Starter storefront. You can now use Stripe during chec ### PayPal Integration - +{/* TODO add links to paypal module once supported. */} + +{/* - [PayPal plugin](../plugins/payment/paypal/page.mdx) installed in the Medusa application. - + */} In your Next.js Starter project, set the following environment variables for the PayPal integration: @@ -141,11 +155,13 @@ Then, restart your Next.js storefront. You'll see a "Search" link in the navigat ### Configure MeiliSearch - +{/* TODO add link to meilisearch plugin/module once available. */} + +{/* - [MeiliSearch plugin](../plugins/search/meilisearch/page.mdx) installed in the Medusa application. - + */} In your Next.js Starter storefront, set the following environment variables for the MeiliSearch integration: @@ -186,11 +202,13 @@ To make sure the Next.js Starter storefront properly displays the products in th ### Configure Algolia - +{/* TODO add links to algolia plugin/module once available. */} + +{/* - [Algolia plugin](../plugins/search/algolia/page.mdx) installed in the Medusa application. - + */} In your Next.js Starter's directory, install the `algoliasearch` package: diff --git a/www/apps/resources/app/page.mdx b/www/apps/resources/app/page.mdx index b8c9f34d05..bd36450ec5 100644 --- a/www/apps/resources/app/page.mdx +++ b/www/apps/resources/app/page.mdx @@ -20,7 +20,7 @@ import { ClockSolid } from "@medusajs/icons" -# Medusa Resources +# Medusa Learning Resources Explore Medusa's commerce modules, SDKs, configurations, recipes, and more. @@ -69,7 +69,7 @@ Follow the [Medusa Book](https://medusa-docs-v2-git-docs-v2-medusajs.vercel.app) } ]} /> -## Plugins +{/* ## Plugins , - title: "S3", - href: "/plugins/storage/s3", - showLinkIcon: false - }, { startIcon: , title: "Segment", href: "/plugins/analytics/segment", showLinkIcon: false }, - { - startIcon: , - title: "Contentful", - href: "/plugins/cms/contentful", - showLinkIcon: false - }, { startIcon: , title: "More Plugins", href: "/plugins", showLinkIcon: false } -]} /> +]} /> */} ## SDKs and Tools + + +Support for v2 in SDK and tools is coming soon. + + + , @@ -139,7 +133,7 @@ Follow the [Medusa Book](https://medusa-docs-v2-git-docs-v2-medusajs.vercel.app) }, ]} /> -## Recipes +{/* ## Recipes - -## API References - - \ No newline at end of file +]} /> */} \ No newline at end of file diff --git a/www/apps/resources/app/troubleshooting/s3-plugin-acl-error/page.mdx b/www/apps/resources/app/troubleshooting/_s3-plugin-acl-error/page.mdx similarity index 100% rename from www/apps/resources/app/troubleshooting/s3-plugin-acl-error/page.mdx rename to www/apps/resources/app/troubleshooting/_s3-plugin-acl-error/page.mdx diff --git a/www/apps/resources/app/troubleshooting/_sections/other/s3-acl.mdx b/www/apps/resources/app/troubleshooting/_sections/other/s3-acl.mdx index 441e749107..bda90d0613 100644 --- a/www/apps/resources/app/troubleshooting/_sections/other/s3-acl.mdx +++ b/www/apps/resources/app/troubleshooting/_sections/other/s3-acl.mdx @@ -1,4 +1,4 @@ -If you're using the [S3 Plugin](../../../plugins/storage/s3/page.mdx) and, when you upload an image, you receive the following error on your Medusa backend: +If you're using the S3 Plugin and, when you upload an image, you receive the following error on your Medusa backend: ```bash noReport AccessControlListNotSupported: The bucket does not allow ACLs diff --git a/www/apps/resources/app/troubleshooting/transaction-promise-all/page.mdx b/www/apps/resources/app/troubleshooting/_transaction-promise-all/page.mdx similarity index 100% rename from www/apps/resources/app/troubleshooting/transaction-promise-all/page.mdx rename to www/apps/resources/app/troubleshooting/_transaction-promise-all/page.mdx diff --git a/www/apps/resources/app/troubleshooting/page.mdx b/www/apps/resources/app/troubleshooting/page.mdx index b76fd2ac40..b62de41015 100644 --- a/www/apps/resources/app/troubleshooting/page.mdx +++ b/www/apps/resources/app/troubleshooting/page.mdx @@ -6,4 +6,10 @@ export const metadata = { # {metadata.title} + + +The following troubleshooting guides were created for Medusa v1 and might not be useful for Medusa v2. + + + \ No newline at end of file diff --git a/www/apps/resources/app/troubleshooting/payment-provider-missing/page.mdx b/www/apps/resources/app/troubleshooting/payment-provider-missing/page.mdx deleted file mode 100644 index f37d8953bb..0000000000 --- a/www/apps/resources/app/troubleshooting/payment-provider-missing/page.mdx +++ /dev/null @@ -1,30 +0,0 @@ -export const metadata = { - title: `Payment Provider not showing in checkout`, -} - -# {metadata.title} - -You add payment providers to your Medusa instance by adding them as plugins in `medusa-config.js`: - -```js title="medusa-config.js" -const plugins = [ - // ... - { - resolve: `medusa-payment-stripe`, - options: { - api_key: STRIPE_API_KEY, - webhook_secret: STRIPE_WEBHOOK_SECRET, - }, - }, -] -``` - -And installing them with your favourite package manager: - -```bash npm2yarn -npm install medusa-payment-stripe -``` - -However, to also show them as part of your checkout flow you need to add them to your regions. - -Then, refer to this user guide to learn how to enable the [payment provider in a region](!user-guide!/settings/regions/providers). diff --git a/www/apps/resources/app/upgrade-guides/page.mdx b/www/apps/resources/app/upgrade-guides/page.mdx new file mode 100644 index 0000000000..2c037d4c79 --- /dev/null +++ b/www/apps/resources/app/upgrade-guides/page.mdx @@ -0,0 +1,11 @@ +export const metadata = { + title: `Troubleshooting Guides`, +} + +# {metadata.title} + + + +Upgrade guides are coming soon for Medusa v2. + + diff --git a/www/apps/resources/app/usage/page.mdx b/www/apps/resources/app/usage/page.mdx index a2e407a9f4..425765484a 100644 --- a/www/apps/resources/app/usage/page.mdx +++ b/www/apps/resources/app/usage/page.mdx @@ -26,11 +26,11 @@ Collecting this data allows us to understand certain details such as: --- -## Medusa application Analytics +## Medusa Application Analytics This section covers which data in the Medusa application are collected and how to opt out of it. -### Collected Data in the Medusa application +### Collected Data in the Medusa Application The following data is being collected on your Medusa application: @@ -93,16 +93,16 @@ To enable anonymization of your data from the Medusa Admin: ### How to Opt-Out -There are two ways to opt out of analytics collected in the Medusa Admin: - -1. Disable the feature flag that is enabled by default for the admin analytics feature: +To opt out of analytics collection in the Medusa Admin, set the following environment variable: ```bash MEDUSA_FF_ANALYTICS=false ``` -2. Alternatively, on your Medusa Admin, you can disable tracking by following these steps: +{/* TODO check steps after admin is ready */} + +{/* 2. Alternatively, on your Medusa Admin, you can disable tracking by following these steps: 1. Go to Settings → Personal Information. 2. In the Usage insights section, click on the “Edit preferences” button. 3. Enable the “Opt out of sharing my usage data” toggle. - 4. Click on the “Submit and close” button. + 4. Click on the “Submit and close” button. */} diff --git a/www/apps/resources/config/index.ts b/www/apps/resources/config/index.ts index 2efdd0bf7e..3481324851 100644 --- a/www/apps/resources/config/index.ts +++ b/www/apps/resources/config/index.ts @@ -3,7 +3,7 @@ import { mobileSidebarItemsV2 } from "docs-ui" import { generatedSidebar } from "../generated/sidebar.mjs" export const config: DocsConfig = { - titleSuffix: "Medusa Resources", + titleSuffix: "Medusa Learning Resources", baseUrl: process.env.NEXT_PUBLIC_BASE_URL || "http://localhost:3000", basePath: process.env.NEXT_PUBLIC_BASE_PATH, sidebar: { diff --git a/www/apps/resources/generated/files-map.mjs b/www/apps/resources/generated/files-map.mjs index ae0f2b3585..2abc873e5e 100644 --- a/www/apps/resources/generated/files-map.mjs +++ b/www/apps/resources/generated/files-map.mjs @@ -1,4 +1,152 @@ export const filesMap = [ + { + "filePath": "/www/apps/resources/app/_plugins/analytics/segment/page.mdx", + "pathname": "/_plugins/analytics/segment" + }, + { + "filePath": "/www/apps/resources/app/_plugins/cms/contentful/page.mdx", + "pathname": "/_plugins/cms/contentful" + }, + { + "filePath": "/www/apps/resources/app/_plugins/cms/strapi/page.mdx", + "pathname": "/_plugins/cms/strapi" + }, + { + "filePath": "/www/apps/resources/app/_plugins/erp/brightpearl/page.mdx", + "pathname": "/_plugins/erp/brightpearl" + }, + { + "filePath": "/www/apps/resources/app/_plugins/fulfillment/manual/page.mdx", + "pathname": "/_plugins/fulfillment/manual" + }, + { + "filePath": "/www/apps/resources/app/_plugins/fulfillment/webshipper/page.mdx", + "pathname": "/_plugins/fulfillment/webshipper" + }, + { + "filePath": "/www/apps/resources/app/_plugins/notifications/mailchimp/page.mdx", + "pathname": "/_plugins/notifications/mailchimp" + }, + { + "filePath": "/www/apps/resources/app/_plugins/notifications/sendgrid/page.mdx", + "pathname": "/_plugins/notifications/sendgrid" + }, + { + "filePath": "/www/apps/resources/app/_plugins/notifications/slack/page.mdx", + "pathname": "/_plugins/notifications/slack" + }, + { + "filePath": "/www/apps/resources/app/_plugins/notifications/twilio-sms/page.mdx", + "pathname": "/_plugins/notifications/twilio-sms" + }, + { + "filePath": "/www/apps/resources/app/_plugins/other/discount-generator/page.mdx", + "pathname": "/_plugins/other/discount-generator" + }, + { + "filePath": "/www/apps/resources/app/_plugins/other/ip-lookup/page.mdx", + "pathname": "/_plugins/other/ip-lookup" + }, + { + "filePath": "/www/apps/resources/app/_plugins/other/restock-notifications/page.mdx", + "pathname": "/_plugins/other/restock-notifications" + }, + { + "filePath": "/www/apps/resources/app/_plugins/other/wishlist/page.mdx", + "pathname": "/_plugins/other/wishlist" + }, + { + "filePath": "/www/apps/resources/app/_plugins/page.mdx", + "pathname": "/_plugins" + }, + { + "filePath": "/www/apps/resources/app/_plugins/payment/klarna/page.mdx", + "pathname": "/_plugins/payment/klarna" + }, + { + "filePath": "/www/apps/resources/app/_plugins/payment/paypal/page.mdx", + "pathname": "/_plugins/payment/paypal" + }, + { + "filePath": "/www/apps/resources/app/_plugins/payment/stripe/page.mdx", + "pathname": "/_plugins/payment/stripe" + }, + { + "filePath": "/www/apps/resources/app/_plugins/search/algolia/page.mdx", + "pathname": "/_plugins/search/algolia" + }, + { + "filePath": "/www/apps/resources/app/_plugins/search/meilisearch/page.mdx", + "pathname": "/_plugins/search/meilisearch" + }, + { + "filePath": "/www/apps/resources/app/_plugins/source/shopify/page.mdx", + "pathname": "/_plugins/source/shopify" + }, + { + "filePath": "/www/apps/resources/app/_plugins/storage/local/page.mdx", + "pathname": "/_plugins/storage/local" + }, + { + "filePath": "/www/apps/resources/app/_plugins/storage/minio/page.mdx", + "pathname": "/_plugins/storage/minio" + }, + { + "filePath": "/www/apps/resources/app/_plugins/storage/s3/page.mdx", + "pathname": "/_plugins/storage/s3" + }, + { + "filePath": "/www/apps/resources/app/_plugins/storage/spaces/page.mdx", + "pathname": "/_plugins/storage/spaces" + }, + { + "filePath": "/www/apps/resources/app/_recipes/b2b/page.mdx", + "pathname": "/_recipes/b2b" + }, + { + "filePath": "/www/apps/resources/app/_recipes/commerce-automation/page.mdx", + "pathname": "/_recipes/commerce-automation" + }, + { + "filePath": "/www/apps/resources/app/_recipes/digital-products/page.mdx", + "pathname": "/_recipes/digital-products" + }, + { + "filePath": "/www/apps/resources/app/_recipes/ecommerce/page.mdx", + "pathname": "/_recipes/ecommerce" + }, + { + "filePath": "/www/apps/resources/app/_recipes/integrate-ecommerce-stack/page.mdx", + "pathname": "/_recipes/integrate-ecommerce-stack" + }, + { + "filePath": "/www/apps/resources/app/_recipes/marketplace/page.mdx", + "pathname": "/_recipes/marketplace" + }, + { + "filePath": "/www/apps/resources/app/_recipes/multi-region-store/page.mdx", + "pathname": "/_recipes/multi-region-store" + }, + { + "filePath": "/www/apps/resources/app/_recipes/omnichannel/page.mdx", + "pathname": "/_recipes/omnichannel" + }, + { + "filePath": "/www/apps/resources/app/_recipes/oms/page.mdx", + "pathname": "/_recipes/oms" + }, + { + "filePath": "/www/apps/resources/app/_recipes/personalized-products/page.mdx", + "pathname": "/_recipes/personalized-products" + }, + { + "filePath": "/www/apps/resources/app/_recipes/pos/page.mdx", + "pathname": "/_recipes/pos" + }, + { + "filePath": "/www/apps/resources/app/_recipes/subscriptions/page.mdx", + "pathname": "/_recipes/subscriptions" + }, { "filePath": "/www/apps/resources/app/admin-widget-injection-zones/page.mdx", "pathname": "/admin-widget-injection-zones" @@ -424,12 +572,12 @@ export const filesMap = [ "pathname": "/commerce-modules/user/user-creation-flows" }, { - "filePath": "/www/apps/resources/app/configurations/medusa-admin/page.mdx", - "pathname": "/configurations/medusa-admin" + "filePath": "/www/apps/resources/app/configurations/_medusa-admin/page.mdx", + "pathname": "/configurations/_medusa-admin" }, { - "filePath": "/www/apps/resources/app/contribution-guidelines/admin-translations/page.mdx", - "pathname": "/contribution-guidelines/admin-translations" + "filePath": "/www/apps/resources/app/contribution-guidelines/_admin-translations/page.mdx", + "pathname": "/contribution-guidelines/_admin-translations" }, { "filePath": "/www/apps/resources/app/contribution-guidelines/docs/page.mdx", @@ -519,158 +667,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/page.mdx", "pathname": "/" }, - { - "filePath": "/www/apps/resources/app/plugins/analytics/segment/page.mdx", - "pathname": "/plugins/analytics/segment" - }, - { - "filePath": "/www/apps/resources/app/plugins/cms/contentful/page.mdx", - "pathname": "/plugins/cms/contentful" - }, - { - "filePath": "/www/apps/resources/app/plugins/cms/strapi/page.mdx", - "pathname": "/plugins/cms/strapi" - }, - { - "filePath": "/www/apps/resources/app/plugins/erp/brightpearl/page.mdx", - "pathname": "/plugins/erp/brightpearl" - }, - { - "filePath": "/www/apps/resources/app/plugins/fulfillment/manual/page.mdx", - "pathname": "/plugins/fulfillment/manual" - }, - { - "filePath": "/www/apps/resources/app/plugins/fulfillment/webshipper/page.mdx", - "pathname": "/plugins/fulfillment/webshipper" - }, - { - "filePath": "/www/apps/resources/app/plugins/notifications/mailchimp/page.mdx", - "pathname": "/plugins/notifications/mailchimp" - }, - { - "filePath": "/www/apps/resources/app/plugins/notifications/sendgrid/page.mdx", - "pathname": "/plugins/notifications/sendgrid" - }, - { - "filePath": "/www/apps/resources/app/plugins/notifications/slack/page.mdx", - "pathname": "/plugins/notifications/slack" - }, - { - "filePath": "/www/apps/resources/app/plugins/notifications/twilio-sms/page.mdx", - "pathname": "/plugins/notifications/twilio-sms" - }, - { - "filePath": "/www/apps/resources/app/plugins/other/discount-generator/page.mdx", - "pathname": "/plugins/other/discount-generator" - }, - { - "filePath": "/www/apps/resources/app/plugins/other/ip-lookup/page.mdx", - "pathname": "/plugins/other/ip-lookup" - }, - { - "filePath": "/www/apps/resources/app/plugins/other/restock-notifications/page.mdx", - "pathname": "/plugins/other/restock-notifications" - }, - { - "filePath": "/www/apps/resources/app/plugins/other/wishlist/page.mdx", - "pathname": "/plugins/other/wishlist" - }, - { - "filePath": "/www/apps/resources/app/plugins/page.mdx", - "pathname": "/plugins" - }, - { - "filePath": "/www/apps/resources/app/plugins/payment/klarna/page.mdx", - "pathname": "/plugins/payment/klarna" - }, - { - "filePath": "/www/apps/resources/app/plugins/payment/paypal/page.mdx", - "pathname": "/plugins/payment/paypal" - }, - { - "filePath": "/www/apps/resources/app/plugins/payment/stripe/page.mdx", - "pathname": "/plugins/payment/stripe" - }, - { - "filePath": "/www/apps/resources/app/plugins/search/algolia/page.mdx", - "pathname": "/plugins/search/algolia" - }, - { - "filePath": "/www/apps/resources/app/plugins/search/meilisearch/page.mdx", - "pathname": "/plugins/search/meilisearch" - }, - { - "filePath": "/www/apps/resources/app/plugins/source/shopify/page.mdx", - "pathname": "/plugins/source/shopify" - }, - { - "filePath": "/www/apps/resources/app/plugins/storage/local/page.mdx", - "pathname": "/plugins/storage/local" - }, - { - "filePath": "/www/apps/resources/app/plugins/storage/minio/page.mdx", - "pathname": "/plugins/storage/minio" - }, - { - "filePath": "/www/apps/resources/app/plugins/storage/s3/page.mdx", - "pathname": "/plugins/storage/s3" - }, - { - "filePath": "/www/apps/resources/app/plugins/storage/spaces/page.mdx", - "pathname": "/plugins/storage/spaces" - }, - { - "filePath": "/www/apps/resources/app/recipes/b2b/page.mdx", - "pathname": "/recipes/b2b" - }, - { - "filePath": "/www/apps/resources/app/recipes/commerce-automation/page.mdx", - "pathname": "/recipes/commerce-automation" - }, - { - "filePath": "/www/apps/resources/app/recipes/digital-products/page.mdx", - "pathname": "/recipes/digital-products" - }, - { - "filePath": "/www/apps/resources/app/recipes/ecommerce/page.mdx", - "pathname": "/recipes/ecommerce" - }, - { - "filePath": "/www/apps/resources/app/recipes/integrate-ecommerce-stack/page.mdx", - "pathname": "/recipes/integrate-ecommerce-stack" - }, - { - "filePath": "/www/apps/resources/app/recipes/marketplace/page.mdx", - "pathname": "/recipes/marketplace" - }, - { - "filePath": "/www/apps/resources/app/recipes/multi-region-store/page.mdx", - "pathname": "/recipes/multi-region-store" - }, - { - "filePath": "/www/apps/resources/app/recipes/omnichannel/page.mdx", - "pathname": "/recipes/omnichannel" - }, - { - "filePath": "/www/apps/resources/app/recipes/oms/page.mdx", - "pathname": "/recipes/oms" - }, - { - "filePath": "/www/apps/resources/app/recipes/personalized-products/page.mdx", - "pathname": "/recipes/personalized-products" - }, - { - "filePath": "/www/apps/resources/app/recipes/pos/page.mdx", - "pathname": "/recipes/pos" - }, - { - "filePath": "/www/apps/resources/app/recipes/subscriptions/page.mdx", - "pathname": "/recipes/subscriptions" - }, { "filePath": "/www/apps/resources/app/references/[...slug]/page.tsx", "pathname": "/references/[...slug]" }, + { + "filePath": "/www/apps/resources/app/troubleshooting/_s3-plugin-acl-error/page.mdx", + "pathname": "/troubleshooting/_s3-plugin-acl-error" + }, { "filePath": "/www/apps/resources/app/troubleshooting/_sections/cli-installation-errors/permission-errors.mdx", "pathname": "/troubleshooting/_sections/cli-installation-errors" @@ -747,6 +751,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/troubleshooting/_sections/other/s3-acl.mdx", "pathname": "/troubleshooting/_sections/other" }, + { + "filePath": "/www/apps/resources/app/troubleshooting/_transaction-promise-all/page.mdx", + "pathname": "/troubleshooting/_transaction-promise-all" + }, { "filePath": "/www/apps/resources/app/troubleshooting/admin-sign-in/page.mdx", "pathname": "/troubleshooting/admin-sign-in" @@ -788,16 +796,8 @@ export const filesMap = [ "pathname": "/troubleshooting" }, { - "filePath": "/www/apps/resources/app/troubleshooting/payment-provider-missing/page.mdx", - "pathname": "/troubleshooting/payment-provider-missing" - }, - { - "filePath": "/www/apps/resources/app/troubleshooting/s3-plugin-acl-error/page.mdx", - "pathname": "/troubleshooting/s3-plugin-acl-error" - }, - { - "filePath": "/www/apps/resources/app/troubleshooting/transaction-promise-all/page.mdx", - "pathname": "/troubleshooting/transaction-promise-all" + "filePath": "/www/apps/resources/app/upgrade-guides/page.mdx", + "pathname": "/upgrade-guides" }, { "filePath": "/www/apps/resources/app/usage/page.mdx", diff --git a/www/apps/resources/generated/sidebar.mjs b/www/apps/resources/generated/sidebar.mjs index 3a0d3d7d85..49d70e86f4 100644 --- a/www/apps/resources/generated/sidebar.mjs +++ b/www/apps/resources/generated/sidebar.mjs @@ -5546,264 +5546,6 @@ export const generatedSidebar = [ } ] }, - { - "loaded": true, - "isPathHref": true, - "path": "/plugins", - "title": "Plugins", - "isChildSidebar": true, - "hasTitleStyling": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "title": "Analytics", - "hasTitleStyling": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/analytics/segment", - "title": "Segment", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "title": "CMS", - "hasTitleStyling": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/cms/contentful", - "title": "Contentful", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/cms/strapi", - "title": "Strapi", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "title": "ERP", - "hasTitleStyling": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/erp/brightpearl", - "title": "Brightpearl", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "title": "Fulfillment", - "hasTitleStyling": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/fulfillment/manual", - "title": "Manual Fulfillment", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/fulfillment/webshipper", - "title": "Webshipper", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "title": "Notifications", - "hasTitleStyling": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/notifications/mailchimp", - "title": "Mailchimp", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/notifications/sendgrid", - "title": "SendGrid", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/notifications/twilio-sms", - "title": "Twilio SMS", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/notifications/slack", - "title": "Slack", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "title": "Payment", - "hasTitleStyling": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/payment/klarna", - "title": "Klarna", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/payment/paypal", - "title": "PayPal", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/payment/stripe", - "title": "Stripe", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "title": "Search", - "hasTitleStyling": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/search/algolia", - "title": "Algolia", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/search/meilisearch", - "title": "MeiliSearch", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "title": "Source", - "hasTitleStyling": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/source/shopify", - "title": "Shopify", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "title": "Storage", - "hasTitleStyling": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/storage/local", - "title": "Local File Storage", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/storage/minio", - "title": "MinIO", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/storage/s3", - "title": "S3", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/storage/spaces", - "title": "Spaces", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "title": "Other", - "hasTitleStyling": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/other/discount-generator", - "title": "Discount Generator", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/other/ip-lookup", - "title": "IP Lookup", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/other/restock-notifications", - "title": "Restock Notifications", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/plugins/other/wishlist", - "title": "Wishlist", - "children": [] - } - ] - } - ] - }, { "loaded": true, "isPathHref": true, @@ -6929,98 +6671,6 @@ export const generatedSidebar = [ } ] }, - { - "loaded": true, - "isPathHref": true, - "title": "Recipes", - "hasTitleStyling": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "path": "/recipes/ecommerce", - "title": "Ecommerce", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/recipes/marketplace", - "title": "Marketplace", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/recipes/subscriptions", - "title": "Subscriptions", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/recipes/integrate-ecommerce-stack", - "title": "Integrate Ecommerce Stack", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/recipes/commerce-automation", - "title": "Commerce Automation", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/recipes/oms", - "title": "Order Management System", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/recipes/pos", - "title": "POS", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/recipes/digital-products", - "title": "Digital Products", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/recipes/personalized-products", - "title": "Personalized Products", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/recipes/b2b", - "title": "B2B", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/recipes/multi-region-store", - "title": "Multi-Region Store", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/recipes/omnichannel", - "title": "Omnichannel Store", - "children": [] - } - ] - }, { "loaded": true, "isPathHref": true, @@ -7033,13 +6683,6 @@ export const generatedSidebar = [ "path": "/references/medusa-config", "title": "Medusa Application", "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/configurations/medusa-admin", - "title": "Medusa Admin", - "children": [] } ] }, @@ -7052,6 +6695,7 @@ export const generatedSidebar = [ { "loaded": true, "isPathHref": true, + "path": "/upgrade-guides", "title": "Upgrade Guides", "children": [] }, @@ -7206,20 +6850,6 @@ export const generatedSidebar = [ "path": "/troubleshooting/database-errors", "title": "Database Errors", "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/troubleshooting/transaction-promise-all", - "title": "Transactions and Promise.all", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/troubleshooting/payment-provider-missing", - "title": "Payment Provider Missing", - "children": [] } ] }, @@ -7272,28 +6902,6 @@ export const generatedSidebar = [ "path": "/troubleshooting/admin-custom-hooks-error", "title": "Custom Hooks Error", "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/troubleshooting/admin-webpack-build-error", - "title": "Webpack Build Error", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "title": "Plugin", - "hasTitleStyling": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "path": "/troubleshooting/s3-plugin-acl-error", - "title": "S3 Plugin ACL Error", - "children": [] } ] } @@ -7381,53 +6989,6 @@ export const generatedSidebar = [ ] } ] - }, - { - "loaded": true, - "isPathHref": true, - "title": "Integration Services", - "children": [ - { - "loaded": true, - "isPathHref": true, - "path": "/references/notification-service", - "title": "Notification Service", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/references/file-service", - "title": "File Service", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/references/search-service", - "title": "Search Service", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "title": "Modules", - "children": [ - { - "loaded": true, - "isPathHref": true, - "title": "Cache Service", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "title": "Event Bus Service", - "children": [] - } - ] } ] }, @@ -7448,13 +7009,6 @@ export const generatedSidebar = [ "path": "/contribution-guidelines/docs", "title": "Docs", "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "path": "/contribution-guidelines/admin-translations", - "title": "Admin Translations", - "children": [] } ] }, diff --git a/www/apps/resources/sidebar.mjs b/www/apps/resources/sidebar.mjs index 0d68f09c5a..b7c0bd7046 100644 --- a/www/apps/resources/sidebar.mjs +++ b/www/apps/resources/sidebar.mjs @@ -1097,170 +1097,6 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, - { - path: "/plugins", - title: "Plugins", - isChildSidebar: true, - hasTitleStyling: true, - children: [ - { - title: "Analytics", - hasTitleStyling: true, - children: [ - { - path: "/plugins/analytics/segment", - title: "Segment", - }, - ], - }, - { - title: "CMS", - hasTitleStyling: true, - children: [ - { - path: "/plugins/cms/contentful", - title: "Contentful", - }, - { - path: "/plugins/cms/strapi", - title: "Strapi", - }, - ], - }, - { - title: "ERP", - hasTitleStyling: true, - children: [ - { - path: "/plugins/erp/brightpearl", - title: "Brightpearl", - }, - ], - }, - { - title: "Fulfillment", - hasTitleStyling: true, - children: [ - { - path: "/plugins/fulfillment/manual", - title: "Manual Fulfillment", - }, - { - path: "/plugins/fulfillment/webshipper", - title: "Webshipper", - }, - ], - }, - { - title: "Notifications", - hasTitleStyling: true, - children: [ - { - path: "/plugins/notifications/mailchimp", - title: "Mailchimp", - }, - { - path: "/plugins/notifications/sendgrid", - title: "SendGrid", - }, - { - path: "/plugins/notifications/twilio-sms", - title: "Twilio SMS", - }, - { - path: "/plugins/notifications/slack", - title: "Slack", - }, - ], - }, - { - title: "Payment", - hasTitleStyling: true, - children: [ - { - path: "/plugins/payment/klarna", - title: "Klarna", - }, - { - path: "/plugins/payment/paypal", - title: "PayPal", - }, - { - path: "/plugins/payment/stripe", - title: "Stripe", - }, - ], - }, - { - title: "Search", - hasTitleStyling: true, - children: [ - { - path: "/plugins/search/algolia", - title: "Algolia", - }, - { - path: "/plugins/search/meilisearch", - title: "MeiliSearch", - }, - ], - }, - { - title: "Source", - hasTitleStyling: true, - children: [ - { - path: "/plugins/source/shopify", - title: "Shopify", - }, - ], - }, - { - title: "Storage", - hasTitleStyling: true, - children: [ - { - path: "/plugins/storage/local", - title: "Local File Storage", - }, - { - path: "/plugins/storage/minio", - title: "MinIO", - }, - { - path: "/plugins/storage/s3", - title: "S3", - }, - { - path: "/plugins/storage/spaces", - title: "Spaces", - }, - ], - }, - { - title: "Other", - hasTitleStyling: true, - children: [ - { - path: "/plugins/other/discount-generator", - title: "Discount Generator", - }, - { - path: "/plugins/other/ip-lookup", - title: "IP Lookup", - }, - { - path: "/plugins/other/restock-notifications", - title: "Restock Notifications", - }, - { - path: "/plugins/other/wishlist", - title: "Wishlist", - }, - ], - }, - ], - }, { title: "SDKs and Tools", hasTitleStyling: true, @@ -1675,60 +1511,6 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, - { - title: "Recipes", - hasTitleStyling: true, - children: [ - { - path: "/recipes/ecommerce", - title: "Ecommerce", - }, - { - path: "/recipes/marketplace", - title: "Marketplace", - }, - { - path: "/recipes/subscriptions", - title: "Subscriptions", - }, - { - path: "/recipes/integrate-ecommerce-stack", - title: "Integrate Ecommerce Stack", - }, - { - path: "/recipes/commerce-automation", - title: "Commerce Automation", - }, - { - path: "/recipes/oms", - title: "Order Management System", - }, - { - path: "/recipes/pos", - title: "POS", - }, - { - path: "/recipes/digital-products", - title: "Digital Products", - }, - { - path: "/recipes/personalized-products", - title: "Personalized Products", - }, - { - path: "/recipes/b2b", - title: "B2B", - }, - { - path: "/recipes/multi-region-store", - title: "Multi-Region Store", - }, - { - path: "/recipes/omnichannel", - title: "Omnichannel Store", - }, - ], - }, { title: "Configurations", hasTitleStyling: true, @@ -1737,10 +1519,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ path: "/references/medusa-config", title: "Medusa Application", }, - { - path: "/configurations/medusa-admin", - title: "Medusa Admin", - }, + // { + // path: "/configurations/medusa-admin", + // title: "Medusa Admin", + // }, ], }, { @@ -1748,6 +1530,7 @@ export const sidebar = sidebarAttachHrefCommonOptions([ hasTitleStyling: true, children: [ { + path: "/upgrade-guides", title: "Upgrade Guides", }, { @@ -1846,14 +1629,6 @@ export const sidebar = sidebarAttachHrefCommonOptions([ path: "/troubleshooting/database-errors", title: "Database Errors", }, - { - path: "/troubleshooting/transaction-promise-all", - title: "Transactions and Promise.all", - }, - { - path: "/troubleshooting/payment-provider-missing", - title: "Payment Provider Missing", - }, ], }, { @@ -1888,20 +1663,6 @@ export const sidebar = sidebarAttachHrefCommonOptions([ path: "/troubleshooting/admin-custom-hooks-error", title: "Custom Hooks Error", }, - { - path: "/troubleshooting/admin-webpack-build-error", - title: "Webpack Build Error", - }, - ], - }, - { - title: "Plugin", - hasTitleStyling: true, - children: [ - { - path: "/troubleshooting/s3-plugin-acl-error", - title: "S3 Plugin ACL Error", - }, ], }, ], @@ -1942,34 +1703,6 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, ], }, - { - title: "Integration Services", - children: [ - { - path: "/references/notification-service", - title: "Notification Service", - }, - { - path: "/references/file-service", - title: "File Service", - }, - { - path: "/references/search-service", - title: "Search Service", - }, - ], - }, - { - title: "Modules", - children: [ - { - title: "Cache Service", - }, - { - title: "Event Bus Service", - }, - ], - }, ], }, { @@ -1983,10 +1716,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([ path: "/contribution-guidelines/docs", title: "Docs", }, - { - path: "/contribution-guidelines/admin-translations", - title: "Admin Translations", - }, + // { + // path: "/contribution-guidelines/admin-translations", + // title: "Admin Translations", + // }, ], }, { diff --git a/www/packages/docs-ui/package.json b/www/packages/docs-ui/package.json index 9f8edfdc6f..1e372a25c4 100644 --- a/www/packages/docs-ui/package.json +++ b/www/packages/docs-ui/package.json @@ -59,7 +59,7 @@ }, "dependencies": { "@medusajs/icons": "^1.2.0", - "@medusajs/ui": "^2.4.1", + "@medusajs/ui": "^3.0.0", "@octokit/request": "^8.1.1", "@react-hook/resize-observer": "^1.2.6", "@segment/analytics-next": "^1.55.0", diff --git a/www/yarn.lock b/www/yarn.lock index 7855ee7609..1cadcb6cd6 100644 --- a/www/yarn.lock +++ b/www/yarn.lock @@ -1326,45 +1326,6 @@ __metadata: languageName: node linkType: hard -"@medusajs/ui@npm:^2.4.1": - version: 2.4.1 - resolution: "@medusajs/ui@npm:2.4.1" - dependencies: - "@medusajs/icons": ^1.2.0 - "@radix-ui/react-accordion": ^1.1.2 - "@radix-ui/react-alert-dialog": ^1.0.4 - "@radix-ui/react-avatar": ^1.0.3 - "@radix-ui/react-checkbox": ^1.0.4 - "@radix-ui/react-dialog": ^1.0.4 - "@radix-ui/react-dropdown-menu": ^2.0.5 - "@radix-ui/react-label": ^2.0.2 - "@radix-ui/react-popover": ^1.0.6 - "@radix-ui/react-portal": ^1.0.3 - "@radix-ui/react-radio-group": ^1.1.3 - "@radix-ui/react-scroll-area": ^1.0.4 - "@radix-ui/react-select": ^2.0.0 - "@radix-ui/react-slot": ^1.0.2 - "@radix-ui/react-switch": ^1.0.3 - "@radix-ui/react-tabs": ^1.0.4 - "@radix-ui/react-toast": ^1.1.4 - "@radix-ui/react-tooltip": ^1.0.6 - "@react-aria/datepicker": ^3.5.0 - "@react-stately/datepicker": ^3.5.0 - clsx: ^1.2.1 - copy-to-clipboard: ^3.3.3 - cva: 1.0.0-beta.1 - date-fns: ^2.30.0 - prism-react-renderer: ^2.0.6 - react-currency-input-field: ^3.6.11 - react-day-picker: ^8.8.0 - tailwind-merge: ^2.2.1 - peerDependencies: - react: ^18.0.0 - react-dom: ^18.0.0 - checksum: 1d044632044b9a3e06ed86d574ad67ccefe797a23b839f32f9d15a2563c4c40fc74b0faf1826bef4aa256b34c30dcae8dc1f11d456de2bfc506162d92fe512d5 - languageName: node - linkType: hard - "@medusajs/ui@npm:^3.0.0": version: 3.0.0 resolution: "@medusajs/ui@npm:3.0.0" @@ -2931,37 +2892,6 @@ __metadata: languageName: node linkType: hard -"@radix-ui/react-toast@npm:^1.1.4": - version: 1.1.5 - resolution: "@radix-ui/react-toast@npm:1.1.5" - dependencies: - "@babel/runtime": ^7.13.10 - "@radix-ui/primitive": 1.0.1 - "@radix-ui/react-collection": 1.0.3 - "@radix-ui/react-compose-refs": 1.0.1 - "@radix-ui/react-context": 1.0.1 - "@radix-ui/react-dismissable-layer": 1.0.5 - "@radix-ui/react-portal": 1.0.4 - "@radix-ui/react-presence": 1.0.1 - "@radix-ui/react-primitive": 1.0.3 - "@radix-ui/react-use-callback-ref": 1.0.1 - "@radix-ui/react-use-controllable-state": 1.0.1 - "@radix-ui/react-use-layout-effect": 1.0.1 - "@radix-ui/react-visually-hidden": 1.0.3 - peerDependencies: - "@types/react": "*" - "@types/react-dom": "*" - react: ^16.8 || ^17.0 || ^18.0 - react-dom: ^16.8 || ^17.0 || ^18.0 - peerDependenciesMeta: - "@types/react": - optional: true - "@types/react-dom": - optional: true - checksum: 1263f1fd4b53f563c0eace84582ff0c82b515100230e35a17b95c44ad420a4e9c156be28787398d3a455d699292dde4dd23311e1d8a0c23ec36931ff6e5a6935 - languageName: node - linkType: hard - "@radix-ui/react-tooltip@npm:^1.0.6": version: 1.0.7 resolution: "@radix-ui/react-tooltip@npm:1.0.7" @@ -5719,7 +5649,7 @@ __metadata: "@mdx-js/loader": ^3.0.0 "@mdx-js/react": ^3.0.0 "@medusajs/icons": ^1.2.0 - "@medusajs/ui": ^2.4.1 + "@medusajs/ui": ^3.0.0 "@next/bundle-analyzer": ^14.2.3 "@next/mdx": 14.2.3 "@readme/openapi-parser": ^2.5.0 @@ -7297,7 +7227,7 @@ __metadata: resolution: "docs-ui@workspace:packages/docs-ui" dependencies: "@medusajs/icons": ^1.2.0 - "@medusajs/ui": ^2.4.1 + "@medusajs/ui": ^3.0.0 "@octokit/request": ^8.1.1 "@react-hook/resize-observer": ^1.2.6 "@segment/analytics-next": ^1.55.0