From 589cb18f98f7ca83c6a103851dcc93ac29ebaf52 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Thu, 26 Jan 2023 15:58:33 +0200 Subject: [PATCH] docs: improved SEO of documentation (#3117) * docs: added description to documentation pages * docs: added more descriptions * docs: finished improving meta description * docs: added searchbox structured data * docs: added breadcrumbs structured data * docs: added how to structured data * docs: improved 404 page * docs: added how-to frontmatter option --- docs/content/add-plugins/algolia.md | 5 ++ .../contentful/customize-contentful.md | 5 ++ docs/content/add-plugins/contentful/index.md | 5 ++ docs/content/add-plugins/klarna.md | 5 ++ docs/content/add-plugins/mailchimp.md | 5 ++ docs/content/add-plugins/meilisearch.md | 5 ++ docs/content/add-plugins/minio.md | 5 ++ docs/content/add-plugins/paypal.md | 5 ++ docs/content/add-plugins/s3.md | 5 ++ docs/content/add-plugins/segment.md | 5 ++ docs/content/add-plugins/sendgrid.mdx | 5 ++ docs/content/add-plugins/slack.md | 5 ++ docs/content/add-plugins/spaces.md | 5 ++ docs/content/add-plugins/strapi.md | 5 ++ docs/content/add-plugins/stripe.md | 5 ++ docs/content/add-plugins/twilio-sms.md | 5 ++ docs/content/admin/development.md | 5 ++ docs/content/admin/quickstart.mdx | 5 ++ docs/content/advanced/admin/import-prices.mdx | 5 ++ .../advanced/admin/import-products.mdx | 5 ++ .../advanced/admin/manage-customers.mdx | 5 ++ .../advanced/admin/manage-discounts.mdx | 5 ++ .../advanced/admin/manage-gift-cards.mdx | 5 ++ .../admin/manage-publishable-api-keys.mdx | 7 +- .../content/advanced/admin/manage-regions.mdx | 5 ++ docs/content/advanced/admin/order-edit.mdx | 5 ++ .../advanced/admin/use-customergroups-api.mdx | 5 ++ .../batch-jobs/{create.md => create.mdx} | 5 ++ .../backend/batch-jobs/customize-import.md | 17 +++-- .../advanced/backend/batch-jobs/index.md | 4 ++ .../advanced/backend/customer-groups/index.md | 4 ++ .../advanced/backend/customers/index.md | 4 ++ .../backend/dependency-container/index.md | 4 ++ .../advanced/backend/discounts/index.md | 4 ++ .../backend/endpoints/add-middleware.md | 5 ++ .../content/advanced/backend/endpoints/add.md | 5 ++ .../advanced/backend/entities/index.md | 5 ++ .../advanced/backend/entities/overview.md | 4 ++ .../advanced/backend/events/architecture.md | 4 ++ .../advanced/backend/feature-flags/toggle.md | 7 +- .../advanced/backend/gift-cards/index.md | 4 ++ .../advanced/backend/migrations/index.md | 5 ++ .../advanced/backend/migrations/overview.md | 4 ++ .../how-to-create-notification-provider.md | 5 ++ .../advanced/backend/notification/overview.md | 4 ++ .../payment/how-to-create-payment-provider.md | 5 ++ .../advanced/backend/payment/overview.md | 4 ++ .../advanced/backend/plugins/create.md | 7 +- .../advanced/backend/plugins/overview.md | 4 ++ .../advanced/backend/price-lists/index.md | 4 ++ .../advanced/backend/price-lists/use-api.mdx | 7 +- .../backend/price-selection-strategy/index.md | 4 ++ .../price-selection-strategy/override.md | 7 +- .../backend/publishable-api-keys/index.md | 4 ++ .../advanced/backend/regions/overview.md | 4 ++ .../advanced/backend/sales-channels/index.md | 4 ++ .../backend/sales-channels/manage-admin.mdx | 5 ++ .../advanced/backend/scheduled-jobs/create.md | 5 ++ .../backend/services/create-service.md | 5 ++ .../advanced/backend/services/overview.md | 4 ++ .../shipping/add-fulfillment-provider.md | 5 ++ .../advanced/backend/shipping/overview.md | 4 ++ .../backend/subscribers/create-subscriber.md | 7 +- .../backend/subscribers/events-list.md | 4 ++ .../advanced/backend/subscribers/overview.md | 4 ++ .../backend/taxes/inclusive-pricing.md | 4 ++ .../backend/taxes/manual-calculation.md | 5 ++ .../advanced/backend/upgrade-guides/index.mdx | 1 + .../ecommerce/handle-order-claim-event.md | 5 ++ .../ecommerce/send-gift-card-to-customer.md | 7 +- .../advanced/storefront/customer-profiles.mdx | 5 ++ .../storefront/handle-order-edits.mdx | 7 +- .../how-to-implement-checkout-flow.mdx | 5 ++ .../storefront/implement-claim-order.mdx | 7 +- .../storefront/use-discounts-in-checkout.mdx | 5 ++ .../advanced/storefront/use-gift-cards.mdx | 5 ++ .../advanced/storefront/use-regions.mdx | 5 ++ .../storefront/use-sales-channels.mdx | 5 ++ docs/content/cli/reference.md | 4 ++ .../deployments/admin/deploying-on-netlify.md | 1 + docs/content/deployments/admin/index.mdx | 1 + .../server/deploying-on-digital-ocean.md | 1 + .../server/deploying-on-heroku.mdx | 1 + .../deployments/server/deploying-on-qovery.md | 1 + .../server/deploying-on-railway.md | 1 + docs/content/deployments/server/index.mdx | 1 + .../storefront/deploying-gatsby-on-netlify.md | 1 + docs/content/deployments/storefront/index.mdx | 1 + docs/content/guides/carts-in-medusa.mdx | 5 ++ docs/content/homepage.mdx | 2 +- docs/content/introduction.md | 6 +- docs/content/js-client/overview.md | 6 +- docs/content/medusa-react/overview.md | 4 ++ .../content/quickstart/quick-start-docker.mdx | 7 +- docs/content/quickstart/quick-start.mdx | 7 +- .../starters/gatsby-medusa-starter.mdx | 4 ++ .../starters/nextjs-medusa-starter.mdx | 4 ++ .../0-set-up-your-development-environment.mdx | 6 +- docs/content/usage/configurations.md | 6 +- docs/content/usage/create-medusa-app.mdx | 5 ++ docs/content/usage/local-development.md | 4 ++ docs/content/user-guide/customers/groups.mdx | 2 + docs/content/user-guide/customers/index.md | 1 + docs/content/user-guide/customers/manage.mdx | 2 + docs/content/user-guide/discounts/create.mdx | 2 + docs/content/user-guide/discounts/index.md | 1 + docs/content/user-guide/discounts/manage.mdx | 2 + docs/content/user-guide/gift-cards/custom.mdx | 2 + docs/content/user-guide/gift-cards/index.md | 1 + docs/content/user-guide/gift-cards/manage.mdx | 2 + docs/content/user-guide/index.mdx | 1 + docs/content/user-guide/lists.mdx | 1 + docs/content/user-guide/orders/claims.mdx | 2 + docs/content/user-guide/orders/drafts.mdx | 2 + docs/content/user-guide/orders/exchange.mdx | 2 + docs/content/user-guide/orders/export.mdx | 2 + .../user-guide/orders/fulfillments.mdx | 2 + docs/content/user-guide/orders/index.md | 1 + docs/content/user-guide/orders/manage.mdx | 2 + docs/content/user-guide/orders/payments.md | 1 + docs/content/user-guide/orders/returns.mdx | 2 + .../content/user-guide/price-lists/import.mdx | 2 + docs/content/user-guide/price-lists/index.md | 1 + .../content/user-guide/price-lists/manage.mdx | 2 + .../user-guide/products/collections.mdx | 2 + docs/content/user-guide/products/export.mdx | 2 + docs/content/user-guide/products/import.mdx | 2 + docs/content/user-guide/products/index.mdx | 1 + docs/content/user-guide/products/manage.mdx | 2 + docs/content/user-guide/regions/index.md | 1 + docs/content/user-guide/regions/manage.mdx | 2 + docs/content/user-guide/regions/providers.mdx | 4 +- .../user-guide/regions/shipping-options.mdx | 5 +- .../user-guide/sales-channels/index.md | 7 +- .../user-guide/sales-channels/manage.mdx | 2 + .../user-guide/sales-channels/products.mdx | 2 + .../content/user-guide/settings/currencies.md | 2 + .../settings/publishable-api-keys.mdx | 2 + .../user-guide/settings/return-reasons.mdx | 2 + docs/content/user-guide/settings/store.md | 1 + docs/content/user-guide/taxes/index.md | 1 + docs/content/user-guide/taxes/manage.md | 2 + .../user-guide/taxes/tax-inclusive.mdx | 2 + .../user-guide/taxes/tax-overrides.mdx | 2 + docs/content/user-guide/taxes/tax-rates.mdx | 2 + docs/content/user-guide/users/index.md | 1 + docs/content/user-guide/users/profile.md | 4 +- docs/content/user-guide/users/team.mdx | 10 ++- www/docs/docusaurus.config.js | 2 +- www/docs/sidebars.js | 9 +-- www/docs/src/components/Feedback/index.js | 8 --- www/docs/src/css/_docspage.css | 4 ++ www/docs/src/theme/Layout/index.js | 4 +- www/docs/src/theme/NotFound.js | 72 +++++++++++++++++++ .../src/theme/StructuredData/HowTo/index.js | 31 ++++++++ .../theme/StructuredData/Searchbox/index.tsx | 27 +++++++ www/docs/src/theme/TOCItems/index.js | 15 ++++ www/docs/src/utils/filterListItems.ts | 1 - 158 files changed, 699 insertions(+), 48 deletions(-) rename docs/content/advanced/backend/batch-jobs/{create.md => create.mdx} (98%) create mode 100644 www/docs/src/theme/NotFound.js create mode 100644 www/docs/src/theme/StructuredData/HowTo/index.js create mode 100644 www/docs/src/theme/StructuredData/Searchbox/index.tsx create mode 100644 www/docs/src/theme/TOCItems/index.js diff --git a/docs/content/add-plugins/algolia.md b/docs/content/add-plugins/algolia.md index 7efc23734c..713bcf9e3b 100644 --- a/docs/content/add-plugins/algolia.md +++ b/docs/content/add-plugins/algolia.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to integrate Algolia with the Medusa server. Learn how to install the Algolia plugin into the Medusa server and how to integrate it into a storefront.' +addHowToData: true +--- + # Algolia In this document, you’ll learn how to install the [Algolia plugin](https://github.com/medusajs/medusa/tree/master/packages/medusa-plugin-algolia) and use it on both your Medusa Server and your storefront. diff --git a/docs/content/add-plugins/contentful/customize-contentful.md b/docs/content/add-plugins/contentful/customize-contentful.md index cfcbad213b..15967dda4f 100644 --- a/docs/content/add-plugins/contentful/customize-contentful.md +++ b/docs/content/add-plugins/contentful/customize-contentful.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to customize the Contentful integration with Medusa and how to customize the Gatsby storefront that is connected to Contentful.' +addHowToData: true +--- + # Customize your Medusa and Contentful Integration In this document, you’ll learn how to customize the Contentful integration with Medusa and how to customize the Gatsby storefront that is connected to Contentful. diff --git a/docs/content/add-plugins/contentful/index.md b/docs/content/add-plugins/contentful/index.md index 1a709a91d5..295ffa8560 100644 --- a/docs/content/add-plugins/contentful/index.md +++ b/docs/content/add-plugins/contentful/index.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to integrate Contentful with the Medusa server and a Gatsby storefront. Contentful is a headless CMS server that provides rich CMS functionalities.' +addHowToData: true +--- + # Contentful In this document, you’ll learn how to integrate a Medusa server with Contentful to add rich Content Management System (CMS) functionalities diff --git a/docs/content/add-plugins/klarna.md b/docs/content/add-plugins/klarna.md index fae6242abb..d6d0e9e88b 100644 --- a/docs/content/add-plugins/klarna.md +++ b/docs/content/add-plugins/klarna.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to integrate Klarna as a payment provider with the Medusa server. Learn how to install Klarna and enable the payment provider in a region.' +addHowToData: true +--- + # Klarna In this document, you’ll learn how to integrate Klarna as a payment provider in Medusa. diff --git a/docs/content/add-plugins/mailchimp.md b/docs/content/add-plugins/mailchimp.md index b1858aab23..7a867c2b22 100644 --- a/docs/content/add-plugins/mailchimp.md +++ b/docs/content/add-plugins/mailchimp.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to integrate Mailchimp with the Medusa server. Learn how to install the plugin on the Medusa server and how to add a subscription form.' +addHowToData: true +--- + # Mailchimp In this document, you’ll learn about the Mailchimp plugin, what it does, and how to use it. diff --git a/docs/content/add-plugins/meilisearch.md b/docs/content/add-plugins/meilisearch.md index c788813a94..6b3651b704 100644 --- a/docs/content/add-plugins/meilisearch.md +++ b/docs/content/add-plugins/meilisearch.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to integrate MeiliSearch with the Medusa server. Learn how to install the MeiliSearch plugin on the Medusa server and integrate it into the storefront.' +addHowToData: true +--- + # MeiliSearch In this document, you’ll learn how to install the [MeiliSearch plugin](https://github.com/medusajs/medusa/tree/master/packages/medusa-plugin-meilisearch) and use it on both your Medusa Server and your storefront. diff --git a/docs/content/add-plugins/minio.md b/docs/content/add-plugins/minio.md index c66c61ed38..ed5ac5fd9b 100644 --- a/docs/content/add-plugins/minio.md +++ b/docs/content/add-plugins/minio.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to integrate MinIO with the Medusa server. Learn how to install the MinIO plugin on the Medusa server and configure it.' +addHowToData: true +--- + # MinIO This document will guide you through installing the MinIO file service plugin on your Medusa server. diff --git a/docs/content/add-plugins/paypal.md b/docs/content/add-plugins/paypal.md index 3586825d6f..78126d7fbd 100644 --- a/docs/content/add-plugins/paypal.md +++ b/docs/content/add-plugins/paypal.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to integrate PayPal with the Medusa server. Learn how to install the PayPal plugin on the Medusa server and integrate into a storefront.' +addHowToData: true +--- + # PayPal This document guides you through setting up PayPal as a payment provider in your Medusa server, admin, and storefront using the [PayPal plugin](https://github.com/medusajs/medusa/tree/master/packages/medusa-payment-paypal). diff --git a/docs/content/add-plugins/s3.md b/docs/content/add-plugins/s3.md index 943d92f606..0350ad172e 100644 --- a/docs/content/add-plugins/s3.md +++ b/docs/content/add-plugins/s3.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to integrate the S3 plugin with the Medusa server. Learn how to configure and use S3 to store images related to the Medusa server.' +addHowToData: true +--- + # S3 In this document, you’ll learn how to install the [S3 plugin](https://github.com/medusajs/medusa/tree/master/packages/medusa-file-s3) on your Medusa server and use it for storage. diff --git a/docs/content/add-plugins/segment.md b/docs/content/add-plugins/segment.md index ff4ed78ae6..028e297483 100644 --- a/docs/content/add-plugins/segment.md +++ b/docs/content/add-plugins/segment.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to integrate Segment with the Medusa server. Learn how to add custom tracking with Segment and Medusa.' +addHowToData: true +--- + # Segment In this document, you’ll learn about the [Segment plugin](https://github.com/medusajs/medusa/tree/master/packages/medusa-plugin-segment), what it does, and how to install and use it. diff --git a/docs/content/add-plugins/sendgrid.mdx b/docs/content/add-plugins/sendgrid.mdx index 0951af214f..f216d68267 100644 --- a/docs/content/add-plugins/sendgrid.mdx +++ b/docs/content/add-plugins/sendgrid.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to integrate SendGrid with the Medusa server. Learn how to install the SendGrid plugin and test it out.' +addHowToData: true +--- + # SendGrid In this document, you’ll learn about the [SendGrid plugin](https://github.com/medusajs/medusa/tree/master/packages/medusa-plugin-sendgrid), what it does, and how to use it. diff --git a/docs/content/add-plugins/slack.md b/docs/content/add-plugins/slack.md index 316d57926c..4ebf2881ec 100644 --- a/docs/content/add-plugins/slack.md +++ b/docs/content/add-plugins/slack.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to integrate Slack with the Medusa server. Learn how to create and configure a Slack app and install the Slack plugin on the Medusa server.' +addHowToData: true +--- + # Slack In this documentation, you'll learn how to add the [Slack plugin](https://github.com/medusajs/medusa/tree/master/packages/medusa-plugin-slack-notification) to your Medusa server to start receiving order notifications. diff --git a/docs/content/add-plugins/spaces.md b/docs/content/add-plugins/spaces.md index 7f31d81587..b5d59a273b 100644 --- a/docs/content/add-plugins/spaces.md +++ b/docs/content/add-plugins/spaces.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to integrate Spaces with the Medusa server. Learn how to install and configure the Spaces plugin on the Medusa server.' +addHowToData: true +--- + # Spaces In this document, you’ll learn how to install the [Spaces plugin](https://github.com/medusajs/medusa/tree/master/packages/medusa-file-spaces) on your Medusa server and use it for storage. diff --git a/docs/content/add-plugins/strapi.md b/docs/content/add-plugins/strapi.md index b957616476..9c9b2f57b4 100644 --- a/docs/content/add-plugins/strapi.md +++ b/docs/content/add-plugins/strapi.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to integrate Strapi with the Medusa server. Learn how to install the plugin and test two-way sync between the ecommerce and CMS services.' +addHowToData: true +--- + # Strapi In this document, you’ll learn how to integrate Strapi with Medusa to add rich Content Management System (CMS) functionalities. diff --git a/docs/content/add-plugins/stripe.md b/docs/content/add-plugins/stripe.md index d657377050..6d986d0643 100644 --- a/docs/content/add-plugins/stripe.md +++ b/docs/content/add-plugins/stripe.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to integrate Stripe with the Medusa server. Learn how to install the Stripe plugin on the Medusa server and integrate it into a storefront.' +addHowToData: true +--- + # Stripe This document guides you through setting up Stripe payments in your Medusa server, admin, and storefront using the [Stripe Plugin](https://github.com/medusajs/medusa/tree/master/packages/medusa-payment-stripe). diff --git a/docs/content/add-plugins/twilio-sms.md b/docs/content/add-plugins/twilio-sms.md index 368c4c48df..f09b03f15f 100644 --- a/docs/content/add-plugins/twilio-sms.md +++ b/docs/content/add-plugins/twilio-sms.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to integrate Twilio SMS with the Medusa server. Learn how to install the Twilio SMS plugin and test it out.' +addHowToData: true +--- + # Twilio SMS In this document, you’ll learn about the Twilio SMS Plugin, what it does, and how to use it in Medusa. diff --git a/docs/content/admin/development.md b/docs/content/admin/development.md index 21e10cebdc..5e11740947 100644 --- a/docs/content/admin/development.md +++ b/docs/content/admin/development.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to set up the Medusa Admin repository for local development and customization. This includes cloning the GitHub repository and adding an upstream repository.' +addHowToData: true +--- + # Customize Medusa Admin In this document, you’ll learn how to customize the Medusa admin by forking it, and how to keep it updated with changes from the main repository. diff --git a/docs/content/admin/quickstart.mdx b/docs/content/admin/quickstart.mdx index ccfd938266..b1f4df545a 100644 --- a/docs/content/admin/quickstart.mdx +++ b/docs/content/admin/quickstart.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to install the Medusa admin. The Medusa admin gives merchants an easy-to-use interface to manage their data such as orders, products, regions, and more.' +addHowToData: true +--- + import Feedback from '@site/src/components/Feedback'; # Medusa Admin Quickstart diff --git a/docs/content/advanced/admin/import-prices.mdx b/docs/content/advanced/admin/import-prices.mdx index 8345426968..8c0f6b3221 100644 --- a/docs/content/advanced/admin/import-prices.mdx +++ b/docs/content/advanced/admin/import-prices.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to bulk-import prices into Medusa using the Admin REST APIs. The steps include uploading a CSV file, creating a batch job for the import, and confirming the batch job.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/content/advanced/admin/import-products.mdx b/docs/content/advanced/admin/import-products.mdx index 8b93dbea5c..02a37597e7 100644 --- a/docs/content/advanced/admin/import-products.mdx +++ b/docs/content/advanced/admin/import-products.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to import products into Medusa using the Admin REST APIs. The steps include uploading a CSV file, creating a batch job for the import, and confirming the batch job.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/content/advanced/admin/manage-customers.mdx b/docs/content/advanced/admin/manage-customers.mdx index de5beedd17..3c4cb10665 100644 --- a/docs/content/advanced/admin/manage-customers.mdx +++ b/docs/content/advanced/admin/manage-customers.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to implement customer-related functionalities for admins using the REST APIs. This includes how to list customers, add a new customer and edit the details of a customer.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/content/advanced/admin/manage-discounts.mdx b/docs/content/advanced/admin/manage-discounts.mdx index 56f72570fc..9b02a7911b 100644 --- a/docs/content/advanced/admin/manage-discounts.mdx +++ b/docs/content/advanced/admin/manage-discounts.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to implement discount functionalities for admins in Medusa using the REST APIs. This includes creating, updating, and deleting discounts, and managing conditions of discounts.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/content/advanced/admin/manage-gift-cards.mdx b/docs/content/advanced/admin/manage-gift-cards.mdx index 389ceebe4a..c90930c2bc 100644 --- a/docs/content/advanced/admin/manage-gift-cards.mdx +++ b/docs/content/advanced/admin/manage-gift-cards.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to implement gift card functionalities for admins using the REST APIs. This includes how to create, update, and delete gift cards, as well as custom gift cards.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/content/advanced/admin/manage-publishable-api-keys.mdx b/docs/content/advanced/admin/manage-publishable-api-keys.mdx index ceab6d2cd6..bbfb3e006b 100644 --- a/docs/content/advanced/admin/manage-publishable-api-keys.mdx +++ b/docs/content/advanced/admin/manage-publishable-api-keys.mdx @@ -1,7 +1,12 @@ +--- +description: 'Learn how to implement publishable API key functionalities for admins in Medusa using the REST APIs. This includes how to list, create, update, and delete a publishable API key.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# Manage Publishable API Keys +# How to Manage Publishable API Keys In this document, you’ll learn how to manage the publishable API keys using the admin APIs. diff --git a/docs/content/advanced/admin/manage-regions.mdx b/docs/content/advanced/admin/manage-regions.mdx index 3884aed775..2e217e1594 100644 --- a/docs/content/advanced/admin/manage-regions.mdx +++ b/docs/content/advanced/admin/manage-regions.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to implement region-related functionalities for admins using the REST APIs. This includes how to list regions, and create, update, and delete regions.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/content/advanced/admin/order-edit.mdx b/docs/content/advanced/admin/order-edit.mdx index deb00593c7..f5048ceaaf 100644 --- a/docs/content/advanced/admin/order-edit.mdx +++ b/docs/content/advanced/admin/order-edit.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to implement order-editing features for admins using the REST APIs. This guide includes how to create an order edit and move order edit to request state, and more.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/content/advanced/admin/use-customergroups-api.mdx b/docs/content/advanced/admin/use-customergroups-api.mdx index e076a49593..d528d35188 100644 --- a/docs/content/advanced/admin/use-customergroups-api.mdx +++ b/docs/content/advanced/admin/use-customergroups-api.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to implement customer group functionalities for admins using the REST APIs. This includes listing customer groups, creating a customer group, managing customers in the group, and more.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/content/advanced/backend/batch-jobs/create.md b/docs/content/advanced/backend/batch-jobs/create.mdx similarity index 98% rename from docs/content/advanced/backend/batch-jobs/create.md rename to docs/content/advanced/backend/batch-jobs/create.mdx index 3cfc6d829a..9bddb1f4ec 100644 --- a/docs/content/advanced/backend/batch-jobs/create.md +++ b/docs/content/advanced/backend/batch-jobs/create.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to create a batch job strategy in the Medusa server. This guide also includes how to test your batch job strategy.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/content/advanced/backend/batch-jobs/customize-import.md b/docs/content/advanced/backend/batch-jobs/customize-import.md index c8ed6a2793..74ca818110 100644 --- a/docs/content/advanced/backend/batch-jobs/customize-import.md +++ b/docs/content/advanced/backend/batch-jobs/customize-import.md @@ -1,4 +1,9 @@ -# Customize Import Strategy +--- +description: 'Learn how to customize the import strategy in Medusa. The import strategy can be used to import entities such as products, prices in a price list, orders, or other entities.' +addHowToData: true +--- + +# How to Customize Import Strategy In this document, you’ll learn how to create a custom product import strategy either by overwriting the default strategy or creating your own. @@ -30,7 +35,7 @@ If you use SQLite during your development, it’s highly recommended that you us The steps required for overwriting a batch job strategy are essentially the same steps required to create a batch job strategy with a minor difference. For that reason, this documentation does not cover the basics of a batch job strategy. -If you’re interested to learn more about batch job strategies and how they work, please check out the [Create Batch Job Strategy documentation](./create.md). +If you’re interested to learn more about batch job strategies and how they work, please check out the [Create Batch Job Strategy documentation](./create.mdx). ### 1. Create a File @@ -69,7 +74,7 @@ export default MyImportStrategy :::note -This is the base implementation of a batch job strategy. You can learn about all the different methods and properties in [this documentation](./create.md#3-define-required-properties). +This is the base implementation of a batch job strategy. You can learn about all the different methods and properties in [this documentation](./create.mdx#3-define-required-properties). ::: @@ -92,7 +97,7 @@ class MyImportStrategy extends AbstractBatchJobStrategy { You can now define your custom functionality in your batch job strategy. For example, you can create custom import logic to import products. -Refer to the [Create a Batch Job documentation](./create.md#3-define-required-properties) to understand what properties and methods are required in your batch job strategy and how you can use them to implement your custom functionality. +Refer to the [Create a Batch Job documentation](./create.mdx#3-define-required-properties) to understand what properties and methods are required in your batch job strategy and how you can use them to implement your custom functionality. ### 5. Run Build Command @@ -104,7 +109,7 @@ npm run build ### 6. Test your Functionality -Since you didn’t create a new batch job type and overwrote the functionality of the strategy, you can test out your functionality using the [same steps used with the default strategy](./create.md#test-your-batch-job-strategy). +Since you didn’t create a new batch job type and overwrote the functionality of the strategy, you can test out your functionality using the [same steps used with the default strategy](./create.mdx#test-your-batch-job-strategy). Specifically, since you create batch jobs using the [Create Batch Job](https://docs.medusajs.com/api/admin/#tag/Batch-Job/operation/PostBatchJobs) endpoint which accepts the batch job type as a body parameter, you just need to send the same type you used for this field. In the example of this documentation, the `type` would be `product-import`. @@ -116,7 +121,7 @@ If you overwrote the import functionality, you can follow [these steps to learn If you don’t want to overwrite Medusa’s batch job strategy, you can create a custom batch job strategy with a different `batchType` value. Then, use that type when you send a request to [Create a Batch Job](https://docs.medusajs.com/api/admin/#tag/Batch-Job). -For more details on creating custom batch job strategies, please check out the [Create Batch Job Strategy documentation](create.md). +For more details on creating custom batch job strategies, please check out the [Create Batch Job Strategy documentation](create.mdx). --- diff --git a/docs/content/advanced/backend/batch-jobs/index.md b/docs/content/advanced/backend/batch-jobs/index.md index caf20ccd22..88b61e4cd2 100644 --- a/docs/content/advanced/backend/batch-jobs/index.md +++ b/docs/content/advanced/backend/batch-jobs/index.md @@ -1,3 +1,7 @@ +--- +description: 'Learn what batch jobs in the Medusa server are and their flow. Batch jobs are tasks that can be performed asynchronously and iteratively in the Medusa server.' +--- + # Batch Jobs In this document, you’ll learn what Batch Jobs are and how they work in Medusa. diff --git a/docs/content/advanced/backend/customer-groups/index.md b/docs/content/advanced/backend/customer-groups/index.md index 6823503e2e..194040eb31 100644 --- a/docs/content/advanced/backend/customer-groups/index.md +++ b/docs/content/advanced/backend/customer-groups/index.md @@ -1,3 +1,7 @@ +--- +description: 'Learn what Customer Groups are and how they can be used in the Medusa server. Customer Groups allow to combine customers with similar attributes into a single group.' +--- + # Customer Groups In this document, you’ll learn about Customer Groups and how they can be used in Medusa. diff --git a/docs/content/advanced/backend/customers/index.md b/docs/content/advanced/backend/customers/index.md index 1f5d6cb104..cd2cbcc641 100644 --- a/docs/content/advanced/backend/customers/index.md +++ b/docs/content/advanced/backend/customers/index.md @@ -1,3 +1,7 @@ +--- +description: 'Learn about what Customers are in Medusa and how they are implemented. Customers are individuals that make purchases in your store.' +--- + # Customers In this document, you’ll learn about Customers and their relation to other entities in Medusa. diff --git a/docs/content/advanced/backend/dependency-container/index.md b/docs/content/advanced/backend/dependency-container/index.md index ea28a8462d..379821d342 100644 --- a/docs/content/advanced/backend/dependency-container/index.md +++ b/docs/content/advanced/backend/dependency-container/index.md @@ -1,3 +1,7 @@ +--- +description: 'Learn what the dependency container is and how to use it in Medusa. Learn also what dependency injection is, and what the resources regsitered and their names are.' +--- + # Dependency Container In this document, you’ll learn what the dependency container is and how you can use it in Medusa. diff --git a/docs/content/advanced/backend/discounts/index.md b/docs/content/advanced/backend/discounts/index.md index 094f96c43e..66867c16ca 100644 --- a/docs/content/advanced/backend/discounts/index.md +++ b/docs/content/advanced/backend/discounts/index.md @@ -1,3 +1,7 @@ +--- +description: 'Learn about the discount architecture in the Medusa server. Discounts are used to offer promotions to the user for marketing purposes.' +--- + # Discounts Architecture In this document, you’ll learn about Discounts architecture and how it works. diff --git a/docs/content/advanced/backend/endpoints/add-middleware.md b/docs/content/advanced/backend/endpoints/add-middleware.md index 0049545e67..f4fc992b7a 100644 --- a/docs/content/advanced/backend/endpoints/add-middleware.md +++ b/docs/content/advanced/backend/endpoints/add-middleware.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to add a middleware in Medusa. A middleware is a function that has access to the request and response objects and can be used to perform actions around an endpoint.' +addHowToData: true +--- + # How to Add a Middleware In this document, you’ll learn how to add a middleware to an existing or custom route in Medusa. diff --git a/docs/content/advanced/backend/endpoints/add.md b/docs/content/advanced/backend/endpoints/add.md index 34c5b1a195..5bd826f027 100644 --- a/docs/content/advanced/backend/endpoints/add.md +++ b/docs/content/advanced/backend/endpoints/add.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to create endpoints in the Medusa server. This guide also includes how to add CORS configurations, creating multiple endpoints, adding protected routes, and more.' +addHowToData: true +--- + # How to Create Endpoints In this document, you’ll learn how to create endpoints in your Medusa server. diff --git a/docs/content/advanced/backend/entities/index.md b/docs/content/advanced/backend/entities/index.md index c7abea1ea1..2aaf8bf238 100644 --- a/docs/content/advanced/backend/entities/index.md +++ b/docs/content/advanced/backend/entities/index.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to create an entity in the Medusa server. This guide also explains how to create a repository and access and delete the entity.' +addHowToData: true +--- + # Create an Entity In this document, you’ll learn how you can create an [Entity](overview.md). diff --git a/docs/content/advanced/backend/entities/overview.md b/docs/content/advanced/backend/entities/overview.md index 550e80da20..e606715e0c 100644 --- a/docs/content/advanced/backend/entities/overview.md +++ b/docs/content/advanced/backend/entities/overview.md @@ -1,3 +1,7 @@ +--- +description: 'Learn what entities are in the Medusa server. There are entities in the Medusa server, and developers can create custom entities.' +--- + # Entities In this document, you'll learn what Entities are in Medusa. diff --git a/docs/content/advanced/backend/events/architecture.md b/docs/content/advanced/backend/events/architecture.md index aa3ade0329..8714d1a0f5 100644 --- a/docs/content/advanced/backend/events/architecture.md +++ b/docs/content/advanced/backend/events/architecture.md @@ -1,3 +1,7 @@ +--- +description: 'Learn how the events system is implemented in Medusa. It is built on a publish-subscribe architecture. The Medusa core publishes events when certain actions take place.' +--- + # Events Architecture In this document, you'll learn how the events system is implemented in Medusa. diff --git a/docs/content/advanced/backend/feature-flags/toggle.md b/docs/content/advanced/backend/feature-flags/toggle.md index 69cebd2c62..ea371b9a78 100644 --- a/docs/content/advanced/backend/feature-flags/toggle.md +++ b/docs/content/advanced/backend/feature-flags/toggle.md @@ -1,4 +1,9 @@ -# Toggle Feature Flags +--- +description: 'Learn how to toggle feature flags in the Medusa server. This guide explains the steps required to toggle a feature flag.' +addHowToData: true +--- + +# How to Toggle Feature Flags In this document, you’ll learn about what feature flags are and how to toggle them. diff --git a/docs/content/advanced/backend/gift-cards/index.md b/docs/content/advanced/backend/gift-cards/index.md index 6fe7773089..7d213ec70c 100644 --- a/docs/content/advanced/backend/gift-cards/index.md +++ b/docs/content/advanced/backend/gift-cards/index.md @@ -1,3 +1,7 @@ +--- +description: 'Learn what gift cards are and how they work in the Medusa server. Learn about the relations between Gift Cards and other entities.' +--- + # Gift Cards In this document, you’ll learn about Gift Cards and how they work in Medusa. diff --git a/docs/content/advanced/backend/migrations/index.md b/docs/content/advanced/backend/migrations/index.md index 784bb8a317..7f2ad29417 100644 --- a/docs/content/advanced/backend/migrations/index.md +++ b/docs/content/advanced/backend/migrations/index.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to create a migration in the Medusa server. This guide explains how to write and run migrations.' +addHowToData: true +--- + # How to Create Migrations In this document, you’ll learn how to create a [Migration](overview.md) using [Typeorm](https://typeorm.io) on your Medusa server. diff --git a/docs/content/advanced/backend/migrations/overview.md b/docs/content/advanced/backend/migrations/overview.md index 743991da6d..1d60316be4 100644 --- a/docs/content/advanced/backend/migrations/overview.md +++ b/docs/content/advanced/backend/migrations/overview.md @@ -1,3 +1,7 @@ +--- +description: 'Learn what Migrations are in the Medusa server and how to run them. Migrations are used to make changes to the database schema the Medusa server is linked to.' +--- + # Migrations In this document, you'll learn what Migrations are in Medusa. diff --git a/docs/content/advanced/backend/notification/how-to-create-notification-provider.md b/docs/content/advanced/backend/notification/how-to-create-notification-provider.md index ede8131a57..fc0c51d303 100644 --- a/docs/content/advanced/backend/notification/how-to-create-notification-provider.md +++ b/docs/content/advanced/backend/notification/how-to-create-notification-provider.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to create a notification provider in the Medusa server. This guide explains the different methods available in a Notification provider.' +addHowToData: true +--- + # How to Create a Notification Provider In this document, you’ll learn how to add a Notification Provider to your Medusa server. diff --git a/docs/content/advanced/backend/notification/overview.md b/docs/content/advanced/backend/notification/overview.md index 44b8261d7c..3481c19ed8 100644 --- a/docs/content/advanced/backend/notification/overview.md +++ b/docs/content/advanced/backend/notification/overview.md @@ -1,3 +1,7 @@ +--- +description: 'Learn about the Notificaiton architecture in Medusa and the automation flow. The Notification Architecture is made up of the Notification Provider and Notification.' +--- + # Notification Architecture Overview This document gives an overview of the notification architecture and how it works. diff --git a/docs/content/advanced/backend/payment/how-to-create-payment-provider.md b/docs/content/advanced/backend/payment/how-to-create-payment-provider.md index c204a1690d..46406c3618 100644 --- a/docs/content/advanced/backend/payment/how-to-create-payment-provider.md +++ b/docs/content/advanced/backend/payment/how-to-create-payment-provider.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to create a payment provider in the Medusa server. This guide explains the different methods available in a fulfillment provider.' +addHowToData: true +--- + # How to Create a Payment Provider In this document, you’ll learn how to add a Payment Provider to your Medusa server. If you’re unfamiliar with the Payment architecture in Medusa, make sure to check out the [overview](./overview.md) first. diff --git a/docs/content/advanced/backend/payment/overview.md b/docs/content/advanced/backend/payment/overview.md index cfea8ef5b9..f146244bdc 100644 --- a/docs/content/advanced/backend/payment/overview.md +++ b/docs/content/advanced/backend/payment/overview.md @@ -1,3 +1,7 @@ +--- +description: 'Learn about the payment architecture in the Medusa server. The payment architecture refers to all operations in the ecommerce store related to processing payments.' +--- + # Payment Architecture Overview In this document, you’ll learn about the payment architecture in Medusa, specifically its 3 main components and the idempotency key. diff --git a/docs/content/advanced/backend/plugins/create.md b/docs/content/advanced/backend/plugins/create.md index 00b160a80d..3f8b8a57b5 100644 --- a/docs/content/advanced/backend/plugins/create.md +++ b/docs/content/advanced/backend/plugins/create.md @@ -1,4 +1,9 @@ -# Create a Plugin +--- +description: 'Learn how to create a plugin in Medusa. This guide explains how to develop, configure, test, and publish the plugins.' +addHowToData: true +--- + +# How to Create a Plugin In this document, you’ll learn how to create a plugin and publish it. If you’re interested to learn more about what plugins are and where to find available official and community plugins, check out the [overview document](overview.md). diff --git a/docs/content/advanced/backend/plugins/overview.md b/docs/content/advanced/backend/plugins/overview.md index 2a3b68f267..ddf8bf2698 100644 --- a/docs/content/advanced/backend/plugins/overview.md +++ b/docs/content/advanced/backend/plugins/overview.md @@ -1,3 +1,7 @@ +--- +description: 'Learn what Plugins are and how they are used in Medusa. Plugins are re-usable customizations that can be added to a Medusa server.' +--- + # Plugins In this document, you’ll get an overview of plugins in Medusa, where to find them, and how to install them. If you want to learn how to create a plugin, check out [this guide](create.md) instead. diff --git a/docs/content/advanced/backend/price-lists/index.md b/docs/content/advanced/backend/price-lists/index.md index f8b10cdba4..1e29901a1e 100644 --- a/docs/content/advanced/backend/price-lists/index.md +++ b/docs/content/advanced/backend/price-lists/index.md @@ -1,3 +1,7 @@ +--- +description: 'Learn what price lists are and how they work in a Medusa server. Price Lists can be used to override product prices based on different conditions.' +--- + # Price Lists In this document, you’ll learn what price lists are and how they work. diff --git a/docs/content/advanced/backend/price-lists/use-api.mdx b/docs/content/advanced/backend/price-lists/use-api.mdx index b471bb45eb..85c2141af2 100644 --- a/docs/content/advanced/backend/price-lists/use-api.mdx +++ b/docs/content/advanced/backend/price-lists/use-api.mdx @@ -1,7 +1,12 @@ +--- +description: 'Learn how to implement price list functionalities for admins using the REST APIs. This includes how to create a price list, retriving price list details, managing prices in the price list, and more.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# How to Use PriceList APIs +# How to Manage PriceLists In this document, you’ll learn how to use the PriceList Admin APIs to create, update, and manage prices in a price list. diff --git a/docs/content/advanced/backend/price-selection-strategy/index.md b/docs/content/advanced/backend/price-selection-strategy/index.md index 1d4adcc7a7..d8f15eac9d 100644 --- a/docs/content/advanced/backend/price-selection-strategy/index.md +++ b/docs/content/advanced/backend/price-selection-strategy/index.md @@ -1,3 +1,7 @@ +--- +description: 'Learn what the price selection strategy is in the Medusa server. The price selection strategy retrieves the best price for a product variant for a specific context.' +--- + # Price Selection Strategy In this document, you’ll learn what a price selection strategy is. diff --git a/docs/content/advanced/backend/price-selection-strategy/override.md b/docs/content/advanced/backend/price-selection-strategy/override.md index dc4b93bf90..2fa519151a 100644 --- a/docs/content/advanced/backend/price-selection-strategy/override.md +++ b/docs/content/advanced/backend/price-selection-strategy/override.md @@ -1,4 +1,9 @@ -# Override Price Selection Strategy +--- +description: 'Learn how to override the price selection strategy. The price selection strategy is used to determine the best price based on a specific context.' +addHowToData: true +--- + +# How to Override Price Selection Strategy In this document, you’ll learn how to override Medusa’s price selection strategy to create a custom pricing strategy. diff --git a/docs/content/advanced/backend/publishable-api-keys/index.md b/docs/content/advanced/backend/publishable-api-keys/index.md index 5cdd03abb9..b88e2cb616 100644 --- a/docs/content/advanced/backend/publishable-api-keys/index.md +++ b/docs/content/advanced/backend/publishable-api-keys/index.md @@ -1,3 +1,7 @@ +--- +description: 'Learn what publishable API keys are and how they can be used in the Medusa server. Publishable API keys can be used to scope API calls with an API key.' +--- + # Publishable API Keys Overview In this document, you’ll learn about Publishable API Keys and their usage. diff --git a/docs/content/advanced/backend/regions/overview.md b/docs/content/advanced/backend/regions/overview.md index 5bf329ba4c..798108f402 100644 --- a/docs/content/advanced/backend/regions/overview.md +++ b/docs/content/advanced/backend/regions/overview.md @@ -1,3 +1,7 @@ +--- +description: 'Learn about what Regions are and how they are used in a Medusa server. Regions represent at least one country on the Medusa server.' +--- + # Regions Overview In this document, you’ll learn about Regions and their importance in your Medusa server. diff --git a/docs/content/advanced/backend/sales-channels/index.md b/docs/content/advanced/backend/sales-channels/index.md index 69702035f9..f4d4f07d0f 100644 --- a/docs/content/advanced/backend/sales-channels/index.md +++ b/docs/content/advanced/backend/sales-channels/index.md @@ -1,3 +1,7 @@ +--- +description: 'Learn what Sales Channels are and how they can be used in Medusa. Sales Channels allow merchants to separate between the different channels products are sold in.' +--- + # Sales Channels In this document, you’ll learn about Sales Channels and how they can be used in Medusa. diff --git a/docs/content/advanced/backend/sales-channels/manage-admin.mdx b/docs/content/advanced/backend/sales-channels/manage-admin.mdx index 8018bfeaa5..0a4df8d6ef 100644 --- a/docs/content/advanced/backend/sales-channels/manage-admin.mdx +++ b/docs/content/advanced/backend/sales-channels/manage-admin.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to implement sales channels features for admins in Medusa using the REST APIs. This includes how to list sales channels, and create, retrieve, update and delete a sales channel. This also includes how to manage products in a sales channel.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/content/advanced/backend/scheduled-jobs/create.md b/docs/content/advanced/backend/scheduled-jobs/create.md index 86fcf8e7e8..f7c0438a6f 100644 --- a/docs/content/advanced/backend/scheduled-jobs/create.md +++ b/docs/content/advanced/backend/scheduled-jobs/create.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to create a scheduled job in the Medusa server. The scheduled job in this example will simply change the status of draft products to published.' +addHowToData: true +--- + # How to Create a Scheduled Job In this document, you’ll learn how to create a scheduled job in Medusa. diff --git a/docs/content/advanced/backend/services/create-service.md b/docs/content/advanced/backend/services/create-service.md index 5180c6adaa..7dfeabfd6d 100644 --- a/docs/content/advanced/backend/services/create-service.md +++ b/docs/content/advanced/backend/services/create-service.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to create a service in Medusa. This guide also includes how to use services in other services, subscribers, and endpoints.' +addHowToData: true +--- + # Create a Service In this document, you’ll learn how you can create a [Service](./overview.md) and use it across your Medusa server just like any of the core services. diff --git a/docs/content/advanced/backend/services/overview.md b/docs/content/advanced/backend/services/overview.md index 6d4209f895..f1ed4b8175 100644 --- a/docs/content/advanced/backend/services/overview.md +++ b/docs/content/advanced/backend/services/overview.md @@ -1,3 +1,7 @@ +--- +description: 'Learn what Services are in the Medusa server. Services represent bundled helper methods that you want to use across the server.' +--- + # Services In this document, you'll learn about what Services are in Medusa. diff --git a/docs/content/advanced/backend/shipping/add-fulfillment-provider.md b/docs/content/advanced/backend/shipping/add-fulfillment-provider.md index 3d41fa456c..a451aafc83 100644 --- a/docs/content/advanced/backend/shipping/add-fulfillment-provider.md +++ b/docs/content/advanced/backend/shipping/add-fulfillment-provider.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to create a fulfillment provider in the Medusa server. This guide explains the different methods in the fulfillment provider.' +addHowToData: true +--- + # How to Add a Fulfillment Provider In this document, you’ll learn how to add a fulfillment provider to a Medusa server. If you’re unfamiliar with the Shipping architecture in Medusa, make sure to [check out the overview first](overview.md). diff --git a/docs/content/advanced/backend/shipping/overview.md b/docs/content/advanced/backend/shipping/overview.md index e5c9f1384e..a12fb128d7 100644 --- a/docs/content/advanced/backend/shipping/overview.md +++ b/docs/content/advanced/backend/shipping/overview.md @@ -1,3 +1,7 @@ +--- +description: 'Learn how the shipping architecture is implemented in the Medusa server. This includes an overview of what the Fulfillment Provider, Shipping Profile, Shipping Option, and Shipping Methods.' +--- + # Shipping Architecture Overview This document gives an overview of the shipping architecture and its four most important components. diff --git a/docs/content/advanced/backend/subscribers/create-subscriber.md b/docs/content/advanced/backend/subscribers/create-subscriber.md index 75dc810e03..0dc3e6d8b9 100644 --- a/docs/content/advanced/backend/subscribers/create-subscriber.md +++ b/docs/content/advanced/backend/subscribers/create-subscriber.md @@ -1,4 +1,9 @@ -# Create a Subscriber +--- +description: 'Learn how to create a subscriber in the Medusa server. You can use subscribers to implement functionalities like sending an order confirmation email.' +addHowToData: true +--- + +# How to Create a Subscriber In this document, you’ll learn how to create a [Subscriber](overview.md) in your Medusa server that listens to events to perform an action. diff --git a/docs/content/advanced/backend/subscribers/events-list.md b/docs/content/advanced/backend/subscribers/events-list.md index 9428717f39..ad60827158 100644 --- a/docs/content/advanced/backend/subscribers/events-list.md +++ b/docs/content/advanced/backend/subscribers/events-list.md @@ -1,3 +1,7 @@ +--- +description: 'Learn about the available events and their data payloads in Medusa. Events can be used to perform an action when the events are triggered.' +--- + # Events Reference This document details all events in Medusa, when they are triggered, and what data your handler method will receive when the event is triggered. diff --git a/docs/content/advanced/backend/subscribers/overview.md b/docs/content/advanced/backend/subscribers/overview.md index c61fa9171e..97b4355981 100644 --- a/docs/content/advanced/backend/subscribers/overview.md +++ b/docs/content/advanced/backend/subscribers/overview.md @@ -1,3 +1,7 @@ +--- +description: 'Learn what subscribers are in the Medusa server. Subscribers are used to listen to triggered events to perform an action.' +--- + # Subscribers In this document, you'll learn what Subscribers are in Medusa. diff --git a/docs/content/advanced/backend/taxes/inclusive-pricing.md b/docs/content/advanced/backend/taxes/inclusive-pricing.md index a106fea87b..3941226103 100644 --- a/docs/content/advanced/backend/taxes/inclusive-pricing.md +++ b/docs/content/advanced/backend/taxes/inclusive-pricing.md @@ -1,3 +1,7 @@ +--- +description: 'Learn what tax-inclusive pricing is and how it works in Medusa. Tax-inclusive pricing allows merchants to set the final prices for products and shipping options regardless of what tax rate is applicable for the customer.' +--- + # Tax Inclusive Pricing In this document, you’ll learn how tax-inclusive pricing works in Medusa. diff --git a/docs/content/advanced/backend/taxes/manual-calculation.md b/docs/content/advanced/backend/taxes/manual-calculation.md index a73d5e6712..0e8b246a46 100644 --- a/docs/content/advanced/backend/taxes/manual-calculation.md +++ b/docs/content/advanced/backend/taxes/manual-calculation.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to manually calculate taxes during checkout in the Medusa server. There are different methods including using endpoints or services.' +addHowToData: true +--- + # Calculate Taxes Manually in Checkout In this document, you’ll learn how to manually calculate taxes during checkout if you have automatic tax calculation disabled in a region. diff --git a/docs/content/advanced/backend/upgrade-guides/index.mdx b/docs/content/advanced/backend/upgrade-guides/index.mdx index 8f74590bc2..219502a8f5 100644 --- a/docs/content/advanced/backend/upgrade-guides/index.mdx +++ b/docs/content/advanced/backend/upgrade-guides/index.mdx @@ -1,5 +1,6 @@ --- hide_table_of_contents: true +description: 'Upgrade guides on how to update the Medusa server along with other Medusa components to the latest version.' --- import DocCardList from '@theme/DocCardList'; diff --git a/docs/content/advanced/ecommerce/handle-order-claim-event.md b/docs/content/advanced/ecommerce/handle-order-claim-event.md index c2d18c7be0..c067c70a9a 100644 --- a/docs/content/advanced/ecommerce/handle-order-claim-event.md +++ b/docs/content/advanced/ecommerce/handle-order-claim-event.md @@ -1,3 +1,8 @@ +--- +description: 'Learn how to handle the order claim event in the Medusa server. When the event is triggered, you can send an email to the customer to inform them about it.' +addHowToData: true +--- + # How to Handle Order Claim Event In this document, you’ll learn how to handle the order claim event and send a confirmation email when the event is triggered. diff --git a/docs/content/advanced/ecommerce/send-gift-card-to-customer.md b/docs/content/advanced/ecommerce/send-gift-card-to-customer.md index d2b11bcc94..f76d7a6e57 100644 --- a/docs/content/advanced/ecommerce/send-gift-card-to-customer.md +++ b/docs/content/advanced/ecommerce/send-gift-card-to-customer.md @@ -1,4 +1,9 @@ -# Send Gift Card Code to Customer +--- +description: 'Learn how to send a gift card code to the customer. Once the customer purchases a gift card, an email can be sent with the code so that they can redeem the gift card.' +addHowToData: true +--- + +# How to Send Gift Card Code to Customer In this document, you’ll learn how to send a customer the gift card code they purchased. diff --git a/docs/content/advanced/storefront/customer-profiles.mdx b/docs/content/advanced/storefront/customer-profiles.mdx index 1e7f4d8c55..7f6e23620f 100644 --- a/docs/content/advanced/storefront/customer-profiles.mdx +++ b/docs/content/advanced/storefront/customer-profiles.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to implement customer account functionalities in your storefront using the REST APIs. This includes implementing customer registration, login, edit profile, and more.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/content/advanced/storefront/handle-order-edits.mdx b/docs/content/advanced/storefront/handle-order-edits.mdx index 47ecdc2019..69a2034cc9 100644 --- a/docs/content/advanced/storefront/handle-order-edits.mdx +++ b/docs/content/advanced/storefront/handle-order-edits.mdx @@ -1,7 +1,12 @@ +--- +description: 'Learn how to implement order-edit related features in the storefront using REST APIs. This includes showing the customer order-edit requests, authorizing additional payments, and confirming or declining order edits.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# How to Handle an Order Edit +# How to Handle an Order Edit in Storefront In this document, you’ll learn how to allow a customer to confirm or decline an Order Edit. diff --git a/docs/content/advanced/storefront/how-to-implement-checkout-flow.mdx b/docs/content/advanced/storefront/how-to-implement-checkout-flow.mdx index b09637cd0d..22d66d070f 100644 --- a/docs/content/advanced/storefront/how-to-implement-checkout-flow.mdx +++ b/docs/content/advanced/storefront/how-to-implement-checkout-flow.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to implement the checkout flow in your storefront using the REST APIs. This includes adding steps related to shipping and payment, then placing the order.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/content/advanced/storefront/implement-claim-order.mdx b/docs/content/advanced/storefront/implement-claim-order.mdx index db3496a08d..7ff038a86a 100644 --- a/docs/content/advanced/storefront/implement-claim-order.mdx +++ b/docs/content/advanced/storefront/implement-claim-order.mdx @@ -1,7 +1,12 @@ +--- +description: 'Learn how to implement the order-claim flow in the storefront. This includes allowing customers to claim their orders, and verify a claim to an order.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# How to Implement Claim Order Flow +# How to Implement Claim Order Flow in Storefront In this document, you’ll learn how to implement the claim order flow in a storefront to allow customers to claim their orders. diff --git a/docs/content/advanced/storefront/use-discounts-in-checkout.mdx b/docs/content/advanced/storefront/use-discounts-in-checkout.mdx index 645df298ab..19ed4c9242 100644 --- a/docs/content/advanced/storefront/use-discounts-in-checkout.mdx +++ b/docs/content/advanced/storefront/use-discounts-in-checkout.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to implement discount functionalities in your storefront using the REST APIs. This includes adding a discount to the cart, showing the discount details, and removing the discount from the cart.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/content/advanced/storefront/use-gift-cards.mdx b/docs/content/advanced/storefront/use-gift-cards.mdx index df3566600d..81c346d016 100644 --- a/docs/content/advanced/storefront/use-gift-cards.mdx +++ b/docs/content/advanced/storefront/use-gift-cards.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to implement gift-card related functionalities in your storefront using the REST APIs. This includes showing the gift card to customers and redeeming the gift card during checkout.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/content/advanced/storefront/use-regions.mdx b/docs/content/advanced/storefront/use-regions.mdx index 9d1598e734..6b16b7b2ff 100644 --- a/docs/content/advanced/storefront/use-regions.mdx +++ b/docs/content/advanced/storefront/use-regions.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to implement region-related functionalities on your storefront using the REST APIs. This includes showing the customer available regions, showing product prices, and setting the region of a cart.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/content/advanced/storefront/use-sales-channels.mdx b/docs/content/advanced/storefront/use-sales-channels.mdx index 42e06becec..55a37e047d 100644 --- a/docs/content/advanced/storefront/use-sales-channels.mdx +++ b/docs/content/advanced/storefront/use-sales-channels.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to implement sales channel functionalities in the storefront using REST APIs. This includes filtering products by Sales Channel and associating a cart with a sales channel.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/content/cli/reference.md b/docs/content/cli/reference.md index be638b79e3..f272fddd1e 100644 --- a/docs/content/cli/reference.md +++ b/docs/content/cli/reference.md @@ -1,3 +1,7 @@ +--- +description: 'Learn how to install the Medusa CLI Tool. Medusa CLI Tool can be used to perform actions such as create a new Medusa server, run migrations, create a new admin user, and more.' +--- + # CLI Reference This document serves as a reference to the Medusa CLI tool including how to install it and what commands are available. diff --git a/docs/content/deployments/admin/deploying-on-netlify.md b/docs/content/deployments/admin/deploying-on-netlify.md index 975c442e3f..9b22413470 100644 --- a/docs/content/deployments/admin/deploying-on-netlify.md +++ b/docs/content/deployments/admin/deploying-on-netlify.md @@ -1,5 +1,6 @@ --- description: 'Learn step-by-step.' +addHowToData: true --- # Deploy Medusa Admin on Netlify diff --git a/docs/content/deployments/admin/index.mdx b/docs/content/deployments/admin/index.mdx index 43bdb54b52..23fccb107e 100644 --- a/docs/content/deployments/admin/index.mdx +++ b/docs/content/deployments/admin/index.mdx @@ -1,5 +1,6 @@ --- hide_table_of_contents: true +description: 'Learn how to deploy the Medusa Admin to different hosting providers to be used with a deployed Medusa server.' --- import DocCardList from '@theme/DocCardList'; diff --git a/docs/content/deployments/server/deploying-on-digital-ocean.md b/docs/content/deployments/server/deploying-on-digital-ocean.md index dffef96150..438609b194 100644 --- a/docs/content/deployments/server/deploying-on-digital-ocean.md +++ b/docs/content/deployments/server/deploying-on-digital-ocean.md @@ -1,5 +1,6 @@ --- description: 'Learn step-by-step.' +addHowToData: true --- # Deploy Your Medusa Server to DigitalOcean Apps diff --git a/docs/content/deployments/server/deploying-on-heroku.mdx b/docs/content/deployments/server/deploying-on-heroku.mdx index 57df2d8de9..6869074a6c 100644 --- a/docs/content/deployments/server/deploying-on-heroku.mdx +++ b/docs/content/deployments/server/deploying-on-heroku.mdx @@ -1,5 +1,6 @@ --- description: 'Learn step-by-step.' +addHowToData: true --- import styles from '../deployment.module.css'; diff --git a/docs/content/deployments/server/deploying-on-qovery.md b/docs/content/deployments/server/deploying-on-qovery.md index 20e094a7fc..ac046b8fdd 100644 --- a/docs/content/deployments/server/deploying-on-qovery.md +++ b/docs/content/deployments/server/deploying-on-qovery.md @@ -1,5 +1,6 @@ --- description: 'Learn step-by-step.' +addHowToData: true --- # Deploy Your Medusa Server on Qovery diff --git a/docs/content/deployments/server/deploying-on-railway.md b/docs/content/deployments/server/deploying-on-railway.md index 65305be3e4..96b1146bf2 100644 --- a/docs/content/deployments/server/deploying-on-railway.md +++ b/docs/content/deployments/server/deploying-on-railway.md @@ -1,5 +1,6 @@ --- description: 'Learn step-by-step.' +addHowToData: true --- # Deploy Your Medusa Server to Railway diff --git a/docs/content/deployments/server/index.mdx b/docs/content/deployments/server/index.mdx index 8bbea14e77..c7f653ffa0 100644 --- a/docs/content/deployments/server/index.mdx +++ b/docs/content/deployments/server/index.mdx @@ -1,5 +1,6 @@ --- hide_table_of_contents: true +description: 'Learn how to deploy your Medusa server to different hosting providers including DigitalOcean, Heroku, Railway, and more.' --- import DocCardList from '@theme/DocCardList'; diff --git a/docs/content/deployments/storefront/deploying-gatsby-on-netlify.md b/docs/content/deployments/storefront/deploying-gatsby-on-netlify.md index 4c2905868e..6480cd02bd 100644 --- a/docs/content/deployments/storefront/deploying-gatsby-on-netlify.md +++ b/docs/content/deployments/storefront/deploying-gatsby-on-netlify.md @@ -1,5 +1,6 @@ --- description: 'Learn step-by-step.' +addHowToData: true --- # Deploy Gatsby Storefront on Netlify diff --git a/docs/content/deployments/storefront/index.mdx b/docs/content/deployments/storefront/index.mdx index 78a07d184e..2c683ece38 100644 --- a/docs/content/deployments/storefront/index.mdx +++ b/docs/content/deployments/storefront/index.mdx @@ -1,5 +1,6 @@ --- hide_table_of_contents: true +description: 'Learn how to deploy your storefronts to different hosting providers to be used with a deployed Medusa server.' --- import DocCardList from '@theme/DocCardList'; diff --git a/docs/content/guides/carts-in-medusa.mdx b/docs/content/guides/carts-in-medusa.mdx index 72739ab0b8..5e3357024b 100644 --- a/docs/content/guides/carts-in-medusa.mdx +++ b/docs/content/guides/carts-in-medusa.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to implement the cart functionality in your storefront using the REST APIs. This includes creating a cart, updating a cart, adding products to the cart, and more.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/content/homepage.mdx b/docs/content/homepage.mdx index ee030460b4..af9d5428c5 100644 --- a/docs/content/homepage.mdx +++ b/docs/content/homepage.mdx @@ -1,7 +1,7 @@ --- id: homepage title: Medusa Documentation -description: "Get an overview of Medusa's features, integrations, and how to use them." +description: "Medusa is an open source composable commerce platform. Learn about its features and how to use it." slug: / hide_table_of_contents: true hide_footer: true diff --git a/docs/content/introduction.md b/docs/content/introduction.md index 41783cfde4..b203ed7381 100644 --- a/docs/content/introduction.md +++ b/docs/content/introduction.md @@ -1,3 +1,7 @@ +--- +description: 'Medusa is composed of three architectures: Medusa server, admin dashboard, and storefront. It also provides advanced ecommerce features such as order management and automated RMA flows.' +--- + # Overview ## Architecture @@ -38,7 +42,7 @@ Your customers use the Storefront to view products and make orders. Medusa provi - [Sales Channels](./user-guide/sales-channels/index.md): Create multiple sales channels and control which sales channels products are available in. - [Bulk Import](./user-guide/products/import.mdx): Bulk import strategies for different entities including [products](./advanced/admin/import-products.mdx) and [price lists](./advanced/admin/import-prices.mdx). - [Bulk Export](./user-guide/products/export.mdx): Bulk export strategies for different entities including [products](./user-guide/products/export.mdx) and [orders](./user-guide/orders/export.mdx). -- Complete Customization Capabilities: Aside from all the features that Medusa provides, it is completely customizable providing capabilities to create custom [endpoints](./advanced/backend/endpoints/add.md), [services](./advanced/backend/services/create-service.md), [subscribers](./advanced/backend/subscribers/create-subscriber.md), [batch job strategies](./advanced/backend/batch-jobs/create.md), and much more! +- Complete Customization Capabilities: Aside from all the features that Medusa provides, it is completely customizable providing capabilities to create custom [endpoints](./advanced/backend/endpoints/add.md), [services](./advanced/backend/services/create-service.md), [subscribers](./advanced/backend/subscribers/create-subscriber.md), [batch job strategies](./advanced/backend/batch-jobs/create.mdx), and much more! --- diff --git a/docs/content/js-client/overview.md b/docs/content/js-client/overview.md index 81277d018b..375053c6fa 100644 --- a/docs/content/js-client/overview.md +++ b/docs/content/js-client/overview.md @@ -1,6 +1,10 @@ +--- +description: 'Learn how to install the Medusa JS Client in a storefront. Medusa JS Client provides easy access to the Medusa API from a client written in TypeScript.' +--- + # Medusa JS Client -The [Medusa JS Client](https://www.npmjs.com/package/@medusajs/medusa-js) provides easy access to the Medusa API from a client written in Typescript. This reference guides you to learn what methods the client has and how you can use them. +The [Medusa JS Client](https://www.npmjs.com/package/@medusajs/medusa-js) provides easy access to the Medusa API from a client written in TypeScript. This reference guides you to learn what methods the client has and how you can use them. This client can be use as an alternative to directly interacting with the [REST APIs](https://docs.medusajs.com/api/store). diff --git a/docs/content/medusa-react/overview.md b/docs/content/medusa-react/overview.md index f783e0411e..254895487e 100644 --- a/docs/content/medusa-react/overview.md +++ b/docs/content/medusa-react/overview.md @@ -1,3 +1,7 @@ +--- +description: 'Learn how to install Medusa React in a React storefront. Medusa React is a React library that provides a set of utilities and hooks for interactive with the Medusa server.' +--- + # Medusa React [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 server. It can be used to build custom React-based storefronts or admin dashboards. diff --git a/docs/content/quickstart/quick-start-docker.mdx b/docs/content/quickstart/quick-start-docker.mdx index c4d38500f8..208b58bcf2 100644 --- a/docs/content/quickstart/quick-start-docker.mdx +++ b/docs/content/quickstart/quick-start-docker.mdx @@ -1,6 +1,11 @@ +--- +description: 'Learn how to create a composable commerce platform using Medusa. This quickstart guide will help you set up your Medusa server using Docker. ' +addHowToData: true +--- + import Feedback from '@site/src/components/Feedback'; -# Quickstart using Docker +# Quickstart using Docker: Medusa Server In this document, you will learn how to make a container of Medusa's app on Docker. Docker is an open source platform for building, deploying, and managing containerized applications. diff --git a/docs/content/quickstart/quick-start.mdx b/docs/content/quickstart/quick-start.mdx index e74085631b..5ff329817c 100644 --- a/docs/content/quickstart/quick-start.mdx +++ b/docs/content/quickstart/quick-start.mdx @@ -1,6 +1,11 @@ +--- +description: 'Learn how to create a composable commerce platform using Medusa. This quickstart guide will help you set up your Medusa server in three steps.' +addHowToData: true +--- + import Feedback from '@site/src/components/Feedback'; -# Quickstart +# Quickstart: Medusa Server This document will guide you through setting up your Medusa server in a few minutes. diff --git a/docs/content/starters/gatsby-medusa-starter.mdx b/docs/content/starters/gatsby-medusa-starter.mdx index 4c892c8f8f..b87ca55c0c 100644 --- a/docs/content/starters/gatsby-medusa-starter.mdx +++ b/docs/content/starters/gatsby-medusa-starter.mdx @@ -1,3 +1,7 @@ +--- +description: 'Learn how to install the Gatsby starter storefront to use with the Medusa Server. The Gatsby storefront includes features related to customer profiles, order returns and exchanges, and more.' +--- + import Feedback from '@site/src/components/Feedback'; # Gatsby Storefront Quickstart diff --git a/docs/content/starters/nextjs-medusa-starter.mdx b/docs/content/starters/nextjs-medusa-starter.mdx index 56947a6e60..4781075ffd 100644 --- a/docs/content/starters/nextjs-medusa-starter.mdx +++ b/docs/content/starters/nextjs-medusa-starter.mdx @@ -1,3 +1,7 @@ +--- +description: 'Learn how to install the Next.js starter storefront to use with Medusa. The Next.js storefront includes ready-integrations with plugins like Stripe and Algolia. It offers features like customer accounts, cart and checkout flows, and more.' +--- + import Feedback from '@site/src/components/Feedback'; # Next.js Storefront Quickstart diff --git a/docs/content/tutorial/0-set-up-your-development-environment.mdx b/docs/content/tutorial/0-set-up-your-development-environment.mdx index 0ef044ca8f..b4987fd38b 100644 --- a/docs/content/tutorial/0-set-up-your-development-environment.mdx +++ b/docs/content/tutorial/0-set-up-your-development-environment.mdx @@ -1,8 +1,12 @@ +--- +description: 'Learn how to set up your development environment while using Medusa. This guide includes how to install Node.js, Git, Medusa CLI tool, PostgreSQL, and Redis.' +--- + import styles from './development.module.css'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# Set up your development environment +# Set up Development Environment This document will guide you to set up your development environment to efficiently and properly use Medusa. diff --git a/docs/content/usage/configurations.md b/docs/content/usage/configurations.md index ff0ba2a998..9bf320cf0d 100644 --- a/docs/content/usage/configurations.md +++ b/docs/content/usage/configurations.md @@ -1,4 +1,8 @@ -# Configure your Server +--- +description: 'Learn about the different configurations available in a Medusa server. This includes configurations related to the database, CORS, plugins, redis, and more.' +--- + +# Configure Medusa Server In this document, you’ll learn what configurations you can add to your Medusa server and how to add them. diff --git a/docs/content/usage/create-medusa-app.mdx b/docs/content/usage/create-medusa-app.mdx index 64e02e5161..b4a34714dc 100644 --- a/docs/content/usage/create-medusa-app.mdx +++ b/docs/content/usage/create-medusa-app.mdx @@ -1,3 +1,8 @@ +--- +description: 'Learn how to create a composable commerce platform using Medusa. This quickstart guide will help you set up your Medusa server, admin, and storefront all at once.' +addHowToData: true +--- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import Feedback from '@site/src/components/Feedback'; diff --git a/docs/content/usage/local-development.md b/docs/content/usage/local-development.md index 7ef4fe5be5..f47a2b2551 100644 --- a/docs/content/usage/local-development.md +++ b/docs/content/usage/local-development.md @@ -1,3 +1,7 @@ +--- +description: 'Learn how to perform local development in the Medusa monorepo. This includes how to use the dev CLI tool and perform unit, integration, and plugin tests.' +--- + # Local Development of Medusa Server and Monorepo In this document, you’ll learn how to customize Medusa’s core and run tests. diff --git a/docs/content/user-guide/customers/groups.mdx b/docs/content/user-guide/customers/groups.mdx index 815ea93b6e..4ead55e79b 100644 --- a/docs/content/user-guide/customers/groups.mdx +++ b/docs/content/user-guide/customers/groups.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 3 +description: 'This user guide explains how to manage customer groups on the Medusa admin. Learn how to create and edit customer groups.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/customers/index.md b/docs/content/user-guide/customers/index.md index ba782a1b0e..c194773077 100644 --- a/docs/content/user-guide/customers/index.md +++ b/docs/content/user-guide/customers/index.md @@ -1,5 +1,6 @@ --- sidebar_position: 1 +description: 'Medusa admin allows merchants to manage customers and customer groups.' --- # Customers Overview diff --git a/docs/content/user-guide/customers/manage.mdx b/docs/content/user-guide/customers/manage.mdx index 9bf1d9a27d..7f57c1659c 100644 --- a/docs/content/user-guide/customers/manage.mdx +++ b/docs/content/user-guide/customers/manage.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 2 +description: 'This user guide explains how to manage customers on the Medusa admin. Learn how to view and edit customers.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/discounts/create.mdx b/docs/content/user-guide/discounts/create.mdx index b74f01f50c..7f5245f7cb 100644 --- a/docs/content/user-guide/discounts/create.mdx +++ b/docs/content/user-guide/discounts/create.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 2 +description: 'This user guide explains how to create a discount on the Medusa admin.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/discounts/index.md b/docs/content/user-guide/discounts/index.md index fab52777c2..4ef56fafc8 100644 --- a/docs/content/user-guide/discounts/index.md +++ b/docs/content/user-guide/discounts/index.md @@ -1,5 +1,6 @@ --- sidebar_position: 1 +description: 'Medusa admin allows merchants to manage discounts. Merchants can create discounts and manage their conditions.' --- # Discounts Overview diff --git a/docs/content/user-guide/discounts/manage.mdx b/docs/content/user-guide/discounts/manage.mdx index 4b63802f5b..b6b1ced784 100644 --- a/docs/content/user-guide/discounts/manage.mdx +++ b/docs/content/user-guide/discounts/manage.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 3 +description: 'This user guide explains how to manage discounts on the Medusa admin. Learn how to edit and delete discounts' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/gift-cards/custom.mdx b/docs/content/user-guide/gift-cards/custom.mdx index d3660ded43..33a0e7bb3e 100644 --- a/docs/content/user-guide/gift-cards/custom.mdx +++ b/docs/content/user-guide/gift-cards/custom.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 3 +description: 'This user guide explains how to manage custom gift cards on the Medusa admin. Learn how to create and edit custom gift cards.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/gift-cards/index.md b/docs/content/user-guide/gift-cards/index.md index 70f0cf46c0..9604793abb 100644 --- a/docs/content/user-guide/gift-cards/index.md +++ b/docs/content/user-guide/gift-cards/index.md @@ -1,5 +1,6 @@ --- sidebar_position: 1 +description: 'Medusa admin allows merchants to manage gift cards. Merchants can manage main and custom gift cards.' --- # Gift Cards Overview diff --git a/docs/content/user-guide/gift-cards/manage.mdx b/docs/content/user-guide/gift-cards/manage.mdx index 66f1faae1c..701fdea273 100644 --- a/docs/content/user-guide/gift-cards/manage.mdx +++ b/docs/content/user-guide/gift-cards/manage.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 2 +description: 'This user guide explains how to manage the main gift card on the Medusa admin. Learn how to create, edit, and delete a gift card.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/index.mdx b/docs/content/user-guide/index.mdx index d906804b6c..e62f5d6c55 100644 --- a/docs/content/user-guide/index.mdx +++ b/docs/content/user-guide/index.mdx @@ -1,6 +1,7 @@ --- sidebar_position: 1 sidebar_label: Introduction +description: 'The user guide explains how to use the Medusa Admin for non technical users. Learn through easy steps how to use the Medusa admin to perform different operations and ecommerce tasks.' --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/lists.mdx b/docs/content/user-guide/lists.mdx index 5b6e8113d4..e931712605 100644 --- a/docs/content/user-guide/lists.mdx +++ b/docs/content/user-guide/lists.mdx @@ -1,5 +1,6 @@ --- sidebar_position: 2 +description: 'Learn how to use utility features in the Medusa Admin including lists, quick and advanced filters, pagination, and search functionalities. You can also customize quick features.' --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/orders/claims.mdx b/docs/content/user-guide/orders/claims.mdx index 521791bde8..a5a4514404 100644 --- a/docs/content/user-guide/orders/claims.mdx +++ b/docs/content/user-guide/orders/claims.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 8 +description: 'This user guide explains how to manage order claims on the Medusa Admin. Learn how to create claims, manage their returns and fulfillments, and more.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/orders/drafts.mdx b/docs/content/user-guide/orders/drafts.mdx index 90d0690c48..ddcde29fb4 100644 --- a/docs/content/user-guide/orders/drafts.mdx +++ b/docs/content/user-guide/orders/drafts.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 5 +description: 'This user guide explains how to manage draft orders on the Medusa Admin. Learn how to create a draft order, view its details, edit a draft order, cancel a draft order, and more.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/orders/exchange.mdx b/docs/content/user-guide/orders/exchange.mdx index b5d1a65854..8c280f83b1 100644 --- a/docs/content/user-guide/orders/exchange.mdx +++ b/docs/content/user-guide/orders/exchange.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 7 +description: 'This user guide explains how to manage exchanges in the Medusa Admin. Learn how to create an order exchange, create an order exchange, mark an order exchange return as received, and cancel an exchange.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/orders/export.mdx b/docs/content/user-guide/orders/export.mdx index 1b21345a78..7e1d2d5972 100644 --- a/docs/content/user-guide/orders/export.mdx +++ b/docs/content/user-guide/orders/export.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 9 +description: 'This user guide explains how to export a list of orders on the Medusa admin.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/orders/fulfillments.mdx b/docs/content/user-guide/orders/fulfillments.mdx index 6cbbd72d93..380e3c80e1 100644 --- a/docs/content/user-guide/orders/fulfillments.mdx +++ b/docs/content/user-guide/orders/fulfillments.mdx @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: Manage Fulfillments +description: 'This user guide explains how to manage order fulfillments in the Medusa Admin. Learn how to create fulfillments, mark fulfillments as shipped, and cancel fulfillments.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/orders/index.md b/docs/content/user-guide/orders/index.md index 1f54612e26..0a1bdbcfb0 100644 --- a/docs/content/user-guide/orders/index.md +++ b/docs/content/user-guide/orders/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 1 sidebar_label: Overview +description: 'Medusa Admin allows merchants to manage orders. Merchants can view order information, capture payment, create shipments and fulfillments, and more.' --- # Orders Overview diff --git a/docs/content/user-guide/orders/manage.mdx b/docs/content/user-guide/orders/manage.mdx index c2a9340326..7677025bd1 100644 --- a/docs/content/user-guide/orders/manage.mdx +++ b/docs/content/user-guide/orders/manage.mdx @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: Manage Details +description: 'Learn in this user guide how to manage orders on the Medusa Admin. Learn how to find the order details page, what information can be found on that page, and how to manage the order details such as shipping address or email.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/orders/payments.md b/docs/content/user-guide/orders/payments.md index 542dcd1b97..6b9ce852b3 100644 --- a/docs/content/user-guide/orders/payments.md +++ b/docs/content/user-guide/orders/payments.md @@ -1,6 +1,7 @@ --- sidebar_position: 3 sidebar_label: Manage Payments +addHowToData: true --- # Manage Order's Payments diff --git a/docs/content/user-guide/orders/returns.mdx b/docs/content/user-guide/orders/returns.mdx index b808fb9cc3..0c32c0d67f 100644 --- a/docs/content/user-guide/orders/returns.mdx +++ b/docs/content/user-guide/orders/returns.mdx @@ -1,6 +1,8 @@ --- sidebar_position: 6 sidebar_label: Manage Returns +description: 'This user guide explains how to manage order returns on the Medusa Admin. Learn how to request a return for an order, mark a return as received, and cancel a return.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/price-lists/import.mdx b/docs/content/user-guide/price-lists/import.mdx index f1f9a85b47..fc72f9aeb3 100644 --- a/docs/content/user-guide/price-lists/import.mdx +++ b/docs/content/user-guide/price-lists/import.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 3 +description: 'This user guide explains how to import prices to a price list on the Medusa admin.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/price-lists/index.md b/docs/content/user-guide/price-lists/index.md index 5de7df3827..1a0dbf386e 100644 --- a/docs/content/user-guide/price-lists/index.md +++ b/docs/content/user-guide/price-lists/index.md @@ -1,5 +1,6 @@ --- sidebar_position: 1 +description: 'Medusa admin allows merchants to manage their price lists. Merchants can override prices or create sales using price lists.' --- # Price Lists Overview diff --git a/docs/content/user-guide/price-lists/manage.mdx b/docs/content/user-guide/price-lists/manage.mdx index 036dfe3841..23b27fc4df 100644 --- a/docs/content/user-guide/price-lists/manage.mdx +++ b/docs/content/user-guide/price-lists/manage.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 2 +description: 'This user guide explains how to manage price lists on the Medusa admin. Learn how to create, edit, and delete price lists.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/products/collections.mdx b/docs/content/user-guide/products/collections.mdx index 981b7f915a..177f12c825 100644 --- a/docs/content/user-guide/products/collections.mdx +++ b/docs/content/user-guide/products/collections.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 3 +description: 'This user guide explains how to manage collections on the Medusa admin. Learn how to create, edit, and delete collections.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/products/export.mdx b/docs/content/user-guide/products/export.mdx index d4dfe90b90..4c4f57f58a 100644 --- a/docs/content/user-guide/products/export.mdx +++ b/docs/content/user-guide/products/export.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 4 +description: 'This user guide explains how to export a list of products on the Medusa admin.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/products/import.mdx b/docs/content/user-guide/products/import.mdx index a9d644e1d7..b092a49500 100644 --- a/docs/content/user-guide/products/import.mdx +++ b/docs/content/user-guide/products/import.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 5 +description: 'This user guide explains how to import a list of products into Medusa using the admin.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/products/index.mdx b/docs/content/user-guide/products/index.mdx index 74cbb0e81e..378dcec3c5 100644 --- a/docs/content/user-guide/products/index.mdx +++ b/docs/content/user-guide/products/index.mdx @@ -1,5 +1,6 @@ --- sidebar_position: 1 +description: 'Medusa admin allows merchants to manage products. Merchants can view products and collections, edit them, and more.' --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/products/manage.mdx b/docs/content/user-guide/products/manage.mdx index 45d761a131..334f9d2a80 100644 --- a/docs/content/user-guide/products/manage.mdx +++ b/docs/content/user-guide/products/manage.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 2 +description: 'This user guide explains how to manage products on the Medusa admin. Learn how to create a product, edit a product, and more.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/regions/index.md b/docs/content/user-guide/regions/index.md index 9877469309..f2632552e3 100644 --- a/docs/content/user-guide/regions/index.md +++ b/docs/content/user-guide/regions/index.md @@ -1,5 +1,6 @@ --- sidebar_position: 1 +description: 'Medusa admin allows merchants to manage regions. Regions represent different countries within an ecommerce store.' --- # Regions Overview diff --git a/docs/content/user-guide/regions/manage.mdx b/docs/content/user-guide/regions/manage.mdx index 0bf73a0e03..571611918f 100644 --- a/docs/content/user-guide/regions/manage.mdx +++ b/docs/content/user-guide/regions/manage.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 2 +description: 'This user guide explains how to manage regions on the Medusa admin. Learn how to create and edit regions.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/regions/providers.mdx b/docs/content/user-guide/regions/providers.mdx index f1246427d5..38c15d4d8b 100644 --- a/docs/content/user-guide/regions/providers.mdx +++ b/docs/content/user-guide/regions/providers.mdx @@ -1,11 +1,13 @@ --- sidebar_position: 3 sidebar_label: Manage Providers +description: 'This user guide explains how to manage payment and fulfillment providers in a region on the Medusa admin.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; -# Manage Payment and Fulfillment Providers +# Manage Payment and Fulfillment Providers in a Region In this document, you’ll learn how to manage a region’s payment and fulfillment providers in your Medusa Admin. diff --git a/docs/content/user-guide/regions/shipping-options.mdx b/docs/content/user-guide/regions/shipping-options.mdx index da97383cb6..63fcb338b5 100644 --- a/docs/content/user-guide/regions/shipping-options.mdx +++ b/docs/content/user-guide/regions/shipping-options.mdx @@ -1,10 +1,13 @@ --- sidebar_position: 4 +sidebar_label: Manage Shipping Options +description: 'This user guide explains how to manage shipping options in a region on the Medusa admin.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; -# Manage Shipping Options +# Manage Shipping Options in a Region In this document, you’ll learn how to manage a region’s shipping options in your Medusa Admin. diff --git a/docs/content/user-guide/sales-channels/index.md b/docs/content/user-guide/sales-channels/index.md index f3e5c006e4..00d9aab361 100644 --- a/docs/content/user-guide/sales-channels/index.md +++ b/docs/content/user-guide/sales-channels/index.md @@ -1,17 +1,12 @@ --- sidebar_position: 1 +description: 'Medusa admin allows merchants to manage their sales channels. Merchants can separate products into multiple sales channels.' --- # Sales Channels Overview In this document, you’ll get an overview of sales channels in Medusa and learn about their importance in your ecommerce store. -:::note - -Sales Channels are currently in beta mode and need to be [manually enabled in your store using feature flags](../../advanced/backend/feature-flags/toggle.md). If you’re unsure how that works, please contact your technical team. - -::: - ## Overview Sales Channels are multiple channels that you can sell your products through. For example, you can have a sales channel for the web storefront, another for the mobile app, and another for selling across social media platforms. diff --git a/docs/content/user-guide/sales-channels/manage.mdx b/docs/content/user-guide/sales-channels/manage.mdx index 18d7fea59d..9e9e203838 100644 --- a/docs/content/user-guide/sales-channels/manage.mdx +++ b/docs/content/user-guide/sales-channels/manage.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 2 +description: 'This user guide explains how to manage sales channels on the Medusa admin. Learn how to create, edit, and delete sales channels.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/sales-channels/products.mdx b/docs/content/user-guide/sales-channels/products.mdx index 41c8b3a6d7..dd9fa00414 100644 --- a/docs/content/user-guide/sales-channels/products.mdx +++ b/docs/content/user-guide/sales-channels/products.mdx @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: Manage Products +description: 'This user guide explains how to manage products in sales channels on the Medusa admin.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/settings/currencies.md b/docs/content/user-guide/settings/currencies.md index 0c896befd4..53d4d419b3 100644 --- a/docs/content/user-guide/settings/currencies.md +++ b/docs/content/user-guide/settings/currencies.md @@ -1,5 +1,7 @@ --- sidebar_position: 2 +description: 'This user guide explains how to manage currencies on the Medusa admin. Learn how to add currencies and set default currency.' +addHowToData: true --- # Manage Currencies diff --git a/docs/content/user-guide/settings/publishable-api-keys.mdx b/docs/content/user-guide/settings/publishable-api-keys.mdx index ccb49e4bbd..d118b479cc 100644 --- a/docs/content/user-guide/settings/publishable-api-keys.mdx +++ b/docs/content/user-guide/settings/publishable-api-keys.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 4 +description: 'This user guide explains how to manage publishable API keys on the Medusa admin. Learn how to create, edit, copy, and revoke publishable API keys.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/settings/return-reasons.mdx b/docs/content/user-guide/settings/return-reasons.mdx index 42a0877399..6e4887eaf8 100644 --- a/docs/content/user-guide/settings/return-reasons.mdx +++ b/docs/content/user-guide/settings/return-reasons.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 3 +description: 'This user guide explains how to manage return reasons on the Medusa admin. Learn how to add, edit, and remove return reasons.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/settings/store.md b/docs/content/user-guide/settings/store.md index d3775c4161..c5bd14c5b0 100644 --- a/docs/content/user-guide/settings/store.md +++ b/docs/content/user-guide/settings/store.md @@ -1,5 +1,6 @@ --- sidebar_position: 1 +description: 'This user guide explains how to manage the store details on the Medusa admin.' --- # Manage Store Details diff --git a/docs/content/user-guide/taxes/index.md b/docs/content/user-guide/taxes/index.md index 898f234bde..3e42b2c2e0 100644 --- a/docs/content/user-guide/taxes/index.md +++ b/docs/content/user-guide/taxes/index.md @@ -1,5 +1,6 @@ --- sidebar_position: 1 +description: 'Medusa admin allows merchants to manage their taxes. Merchants can specify and configure taxes per region.' --- # Taxes Overview diff --git a/docs/content/user-guide/taxes/manage.md b/docs/content/user-guide/taxes/manage.md index 198162a422..d6d0b47d87 100644 --- a/docs/content/user-guide/taxes/manage.md +++ b/docs/content/user-guide/taxes/manage.md @@ -1,5 +1,7 @@ --- sidebar_position: 2 +description: 'This user guide explains how to manage taxes on the Medusa admin. Learn how to edit their configurations.' +addHowToData: true --- # Manage Taxes diff --git a/docs/content/user-guide/taxes/tax-inclusive.mdx b/docs/content/user-guide/taxes/tax-inclusive.mdx index 4f3c621eb0..10bd287844 100644 --- a/docs/content/user-guide/taxes/tax-inclusive.mdx +++ b/docs/content/user-guide/taxes/tax-inclusive.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 5 +description: 'This user guide explains how to manage tax inclusive pricing on the Medusa admin.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/taxes/tax-overrides.mdx b/docs/content/user-guide/taxes/tax-overrides.mdx index 86ff054f60..5f92608553 100644 --- a/docs/content/user-guide/taxes/tax-overrides.mdx +++ b/docs/content/user-guide/taxes/tax-overrides.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 4 +description: 'This user guide explains how to manage tax overrides on the Medusa admin. Learn how to add, edit, and delete overrides.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/taxes/tax-rates.mdx b/docs/content/user-guide/taxes/tax-rates.mdx index 4e535158fc..2a56f6b75e 100644 --- a/docs/content/user-guide/taxes/tax-rates.mdx +++ b/docs/content/user-guide/taxes/tax-rates.mdx @@ -1,5 +1,7 @@ --- sidebar_position: 3 +description: 'This user guide explains how to manage tax rates on the Medusa admin. Learn how to create, edit, and delete tax rates.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/users/index.md b/docs/content/user-guide/users/index.md index 0b423b9fdf..1688355f5c 100644 --- a/docs/content/user-guide/users/index.md +++ b/docs/content/user-guide/users/index.md @@ -1,5 +1,6 @@ --- sidebar_position: 1 +description: 'Medusa admin can be accessed more than one user. Merchants can have users added into their team to use the Medusa admin.' --- # Users Overview diff --git a/docs/content/user-guide/users/profile.md b/docs/content/user-guide/users/profile.md index f7dc5633d9..c2ef1293aa 100644 --- a/docs/content/user-guide/users/profile.md +++ b/docs/content/user-guide/users/profile.md @@ -1,5 +1,7 @@ --- -sidebar_position: 1 +sidebar_position: 2 +description: 'This user guide explains how to manage user profile on the Medusa admin. Learn how to edit a user profile and reset user password.' +addHowToData: true --- # Manage Profile diff --git a/docs/content/user-guide/users/team.mdx b/docs/content/user-guide/users/team.mdx index 4565624b8d..bce8b11b1f 100644 --- a/docs/content/user-guide/users/team.mdx +++ b/docs/content/user-guide/users/team.mdx @@ -1,5 +1,7 @@ --- -sidebar_position: 2 +sidebar_position: 3 +description: 'This user guide explains how to manage the team on the Medusa admin. Learn how to invite users to your team and edit their details.' +addHowToData: true --- import UiIcon from '@site/src/components/UiIcon'; @@ -12,6 +14,8 @@ In this document, you’ll learn how to invite new users, edit other users’ in You can view your team by going to Settings → The Team. +--- + ## Manage Invites To add a new user to your team, you must invite them. Invites are sent by email, but you can also copy the invite link and send it personally to the user. @@ -60,6 +64,8 @@ To remove an invite: 3. Click on “Remove invitation” from the dropdown. 4. Confirm removing the invitation by clicking the “Yes, remove” button in the pop-up. +--- + ## Edit a User’s Details To edit a user’s details in your team: @@ -69,6 +75,8 @@ To edit a user’s details in your team: 3. In the new form, edit any of the user’s information. 4. Once done, click on the Save button. +--- + ## Remove a User :::warning diff --git a/www/docs/docusaurus.config.js b/www/docs/docusaurus.config.js index 2b0873de38..724b733417 100644 --- a/www/docs/docusaurus.config.js +++ b/www/docs/docusaurus.config.js @@ -210,7 +210,7 @@ const config = { [require('@docusaurus/remark-plugin-npm2yarn'), {sync: true}], ], showLastUpdateTime: true, - breadcrumbs: false, + // breadcrumbs: false, async sidebarItemsGenerator({defaultSidebarItemsGenerator, ...args}) { const sidebarItems = await defaultSidebarItemsGenerator(args); return reverseSidebar(sidebarItems); diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index 1ea583f512..1678897c08 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -32,17 +32,18 @@ module.exports = { items: [ { type: "doc", - id: "quickstart/quick-start", - label: "Quickstart Guide", + id: "usage/create-medusa-app", + label: 'create-medusa-app' }, { type: "doc", - id: "usage/create-medusa-app", - label: 'Use create-medusa-app' + id: "quickstart/quick-start", + label: "Server Quickstart", }, { type:"doc", id: "quickstart/quick-start-docker", + label: "Server Quickstart: Docker", }, ] }, diff --git a/www/docs/src/components/Feedback/index.js b/www/docs/src/components/Feedback/index.js index ead2a3c2b5..6129c48867 100644 --- a/www/docs/src/components/Feedback/index.js +++ b/www/docs/src/components/Feedback/index.js @@ -38,15 +38,11 @@ export default function Feedback ({ } function submitFeedback (e, feedback = null) { - console.log(id, feedback, (feedback !== null && feedback) || (feedback === null && positiveFeedback) ? 'yes' : 'no') if (isBrowser) { - console.log("here1"); if (window.analytics) { - console.log("here3"); if (showForm) { setLoading(true); } - console.log("here4"); window.analytics.track(event, { url: location.pathname, label: document.title, @@ -54,17 +50,13 @@ export default function Feedback ({ message, uuid: id }, function () { - console.log("here5"); if (showForm) { setLoading(false); - console.log("here6"); resetForm(); } }) } else { - console.log("here7"); if (showForm) { - console.log("here8"); resetForm(); } } diff --git a/www/docs/src/css/_docspage.css b/www/docs/src/css/_docspage.css index deb48dfd4c..3196e2df36 100644 --- a/www/docs/src/css/_docspage.css +++ b/www/docs/src/css/_docspage.css @@ -1,3 +1,7 @@ +.theme-doc-breadcrumbs { + display: none; +} + article { max-width: var(--ifm-docs-page-max-width); } diff --git a/www/docs/src/theme/Layout/index.js b/www/docs/src/theme/Layout/index.js index d0271ba021..9b0465017b 100644 --- a/www/docs/src/theme/Layout/index.js +++ b/www/docs/src/theme/Layout/index.js @@ -15,6 +15,7 @@ import ErrorPageContent from '@theme/ErrorPageContent'; import styles from './styles.module.css'; import useIsBrowser from '@docusaurus/useIsBrowser'; import {useLocation} from '@docusaurus/router'; +import StructuredDataSearchbox from '../StructuredData/Searchbox'; export default function Layout(props) { const { @@ -49,12 +50,11 @@ export default function Layout(props) { } }, [isBrowser, location.pathname]); - useKeyboardNavigation(); return ( - + {isBrowser && location.pathname === '/' && } diff --git a/www/docs/src/theme/NotFound.js b/www/docs/src/theme/NotFound.js new file mode 100644 index 0000000000..6d5fdebf29 --- /dev/null +++ b/www/docs/src/theme/NotFound.js @@ -0,0 +1,72 @@ +import React from 'react'; +import Translate, {translate} from '@docusaurus/Translate'; +import {PageMetadata} from '@docusaurus/theme-common'; +import Layout from '@theme/Layout'; +import useBaseUrl from '@docusaurus/useBaseUrl' + +export default function NotFound() { + return ( + <> + + +
+
+
+

+ + Page Not Found + +

+

+ + Looks like the page you're looking for has either changed into a different + location or isn't in our documentation anymore. + +

+

+ If you think this is a mistake, please + report this issue on GitHub + +

+

Some popular links

+ +
+
+
+ + + ); +} diff --git a/www/docs/src/theme/StructuredData/HowTo/index.js b/www/docs/src/theme/StructuredData/HowTo/index.js new file mode 100644 index 0000000000..a42a21eae6 --- /dev/null +++ b/www/docs/src/theme/StructuredData/HowTo/index.js @@ -0,0 +1,31 @@ +import React from "react" +import Head from '@docusaurus/Head' +import {useLocation} from '@docusaurus/router'; +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; + +export default function StructuredDataHowTo ({ toc, title }) { + const location = useLocation(); + const { siteConfig: { url } } = useDocusaurusContext() + const mainUrl = `${url}/${location.pathname}` + + return ( + + + + ) +} \ No newline at end of file diff --git a/www/docs/src/theme/StructuredData/Searchbox/index.tsx b/www/docs/src/theme/StructuredData/Searchbox/index.tsx new file mode 100644 index 0000000000..61735c3014 --- /dev/null +++ b/www/docs/src/theme/StructuredData/Searchbox/index.tsx @@ -0,0 +1,27 @@ +import React from 'react'; +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; +import Head from '@docusaurus/Head'; + +export default function StructuredDataSearchbox () { + const { siteConfig: { url } } = useDocusaurusContext() + + return ( + + + + ) +} \ No newline at end of file diff --git a/www/docs/src/theme/TOCItems/index.js b/www/docs/src/theme/TOCItems/index.js new file mode 100644 index 0000000000..8e64bd71ae --- /dev/null +++ b/www/docs/src/theme/TOCItems/index.js @@ -0,0 +1,15 @@ +import React from 'react'; +import TOCItems from '@theme-original/TOCItems'; +import StructuredDataHowTo from '../StructuredData/HowTo'; +import { useDoc } from '@docusaurus/theme-common/internal' + +export default function TOCItemsWrapper(props) { + const { frontMatter, contentTitle } = useDoc() + + return ( + <> + + {frontMatter?.addHowToData && } + + ); +} diff --git a/www/docs/src/utils/filterListItems.ts b/www/docs/src/utils/filterListItems.ts index e0c70cae3c..b78026f27f 100644 --- a/www/docs/src/utils/filterListItems.ts +++ b/www/docs/src/utils/filterListItems.ts @@ -1,7 +1,6 @@ import { PropSidebarItem, PropSidebarItemLink } from '@docusaurus/plugin-content-docs' export default function filterListItems (items: PropSidebarItemLink[], pathPattern: string | RegExp): PropSidebarItemLink[] { - console.log(items) if (!items.length) { return items }