docs: create docs workspace (#5174)
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"position": 9,
|
||||
"collapsed": false,
|
||||
"link": null,
|
||||
"label": "Regions",
|
||||
"customProps": {
|
||||
"sidebar_is_group_headline": true
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: 'Medusa admin allows merchants to manage regions. Regions represent different countries within an ecommerce store.'
|
||||
---
|
||||
|
||||
# Regions Overview
|
||||
|
||||
In this document, you’ll get an overview of regions and learn about their importance in your ecommerce store.
|
||||
|
||||
## Overview
|
||||
|
||||
Regions are essential to your ecommerce store. They allow you to specify available currencies, payment providers, fulfillment providers, tax rates, and more for different regions.
|
||||
|
||||
Regions represent different countries that your ecommerce store serves customers in. You can combine more than one country in the same region and give them the same settings, or you can create a different region for each country and add settings specific to each of them.
|
||||
|
||||
---
|
||||
|
||||
## Currencies in Regions
|
||||
|
||||
Each region uses one currency. Having more than one region with each having different currencies allows you to set prices and amounts throughout your ecommerce store for each currency. For example, you can specify prices for a product for each currency you support.
|
||||
|
||||
---
|
||||
|
||||
## How Customers Use Regions
|
||||
|
||||
When a customer browses your storefront, they can choose the region based on their location. Then, different pricing, shipping providers, payment providers, and taxes will be available and applied based on the chosen region.
|
||||
|
||||
For example, if you have Stripe enabled as a payment provider in a region created for the United States, but have it disabled in a region created for European countries, only customers in the United States region can use Stripe for payment on checkout.
|
||||
|
||||
---
|
||||
|
||||
## Learn More About Regions
|
||||
|
||||
- [Manage Regions](./manage.mdx)
|
||||
- [Manage Payment and Fulfillment Providers](./providers.mdx)
|
||||
- [Manage Shipping Options in a Region](./shipping-options.mdx)
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
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';
|
||||
|
||||
# Manage Regions
|
||||
|
||||
In this document, you’ll learn how to view and manage regions in your Medusa Admin.
|
||||
|
||||
## View Regions
|
||||
|
||||
To view your regions:
|
||||
|
||||
1. Click on Settings in the sidebar.
|
||||
2. Choose Regions from the list of settings.
|
||||
|
||||
This opens the Regions page where you can find a list of regions.
|
||||
|
||||
---
|
||||
|
||||
## Create a Region
|
||||
|
||||
To create a region:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> icon at the top right of the Regions section.
|
||||
3. In the form that opens you must enter the Regions details:
|
||||
- It is required to enter a title, choose a currency, enter a tax rate, and at least choose one country, payment provider, and fulfillment provider.
|
||||
- You can optionally enter a tax code for the region. Alternatively, you can [edit a region’s tax settings](../taxes/manage.md#edit-a-regions-taxes) after creation.
|
||||
4. Once you’re done, click on the "Create region" button.
|
||||
|
||||
:::tip
|
||||
|
||||
If you can’t find the currency you want to use in the Currency field, make sure to [add the Currency to the store’s currencies in the settings](../settings/currencies.md#add-a-currency).
|
||||
|
||||
:::
|
||||
|
||||
After you click save, the region will be created and you can see it in the list on the left.
|
||||
|
||||
---
|
||||
|
||||
## Edit a Region
|
||||
|
||||
To edit a region's basic information:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Click on the region you want to edit from the Regions section. This shows sections to the right to edit different information and data related to the region.
|
||||
4. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at the top right of the first section.
|
||||
5. Click on "Edit Region Details" from the dropdown.
|
||||
6. This opens a new window where you can edit the region's details.
|
||||
7. Once done, click on the "Save and close" button.
|
||||
|
||||
---
|
||||
|
||||
## Delete a Region
|
||||
|
||||
:::warning
|
||||
|
||||
If you delete a region, you will not be able to restore it or its data. Data related to the region such as tax settings will also be deleted. Prices using the currencies of this region will remain available.
|
||||
|
||||
:::
|
||||
|
||||
To delete a region:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Click on the region you want to delete from the Regions section.
|
||||
3. In the first section on the right, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon.
|
||||
4. Choose Delete Region from the dropdown list.
|
||||
5. Confirm deleting the region by entering the name of the region and clicking the “Yes, confirm" button in the pop-up.
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
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 in a Region
|
||||
|
||||
In this document, you’ll learn how to manage a region’s payment and fulfillment providers in your Medusa Admin.
|
||||
|
||||
## Overview
|
||||
|
||||
You can choose the payment and fulfillment providers available in each region. This allows you to provide customers in specific regions the providers that are available in their country or region.
|
||||
|
||||
When a payment or fulfillment provider is added to a region, it means a customer is able to select that payment or fulfillment provider during checkout to complete their purchase.
|
||||
|
||||
---
|
||||
|
||||
## Manage Payment Providers
|
||||
|
||||
To add or remove a payment provider in a region:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Select a region to edit.
|
||||
3. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at the top right of the first section on the right.
|
||||
4. Click on Edit Region Details from the dropdown.
|
||||
5. Under the providers section, select the payment providers you want to add to the region.
|
||||
6. Unselect the payment providers you want to remove from the region.
|
||||
7. Click the "Save and close" button.
|
||||
|
||||
---
|
||||
|
||||
## Manage Fulfillment Providers
|
||||
|
||||
To add or remove a fulfillment provider in a region:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Select a region to edit.
|
||||
3. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at the top right of the first section on the right.
|
||||
4. Click on Edit Region Details from the dropdown.
|
||||
5. Under the providers section, select the fulfillment providers you want to add to the region.
|
||||
6. Unselect the fulfillment providers you want to remove from the region.
|
||||
7. Click the "Save and close" button.
|
||||
@@ -0,0 +1,124 @@
|
||||
---
|
||||
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 in a Region
|
||||
|
||||
In this document, you’ll learn how to manage a region’s shipping options in your Medusa Admin.
|
||||
|
||||
## Types of Shipping Options
|
||||
|
||||
There are two types of shipping options in a region:
|
||||
|
||||
1. Shipping Options that are used when a customer places an order or when an admin creates a draft order.
|
||||
2. Return Shipping Options that are used when a customer requests a return or exchange for their order, or when an admin registers an exchange, a claim, or a return for an order.
|
||||
|
||||
A shipping option can’t be used for both cases. In a region, you can create an unlimited amount of shipping options and return shipping options.
|
||||
|
||||
---
|
||||
|
||||
## Manage Shipping Options in a Region
|
||||
|
||||
### Add Shipping Option to a Region
|
||||
|
||||
To add a shipping option:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Select the shipping option's region.
|
||||
3. Scroll down to the Shipping Options section on the right side.
|
||||
4. Click on the Add Option button.
|
||||
5. A new window will open with a form with the following fields:
|
||||
- **Visible in Store:** Whether or not this option should be available on the website. This is useful if you want to create a shipping option only for use on the Medusa Admin (for example, to create draft orders).
|
||||
- **Title (Required):** The name of the shipping option. The customer will see this name on the storefront if the “Show on Website” field is checked.
|
||||
- **Price Type (Required):** The type of price. It can be either Flat Rate or Calculated. If you choose Flat Rate, this will show a new field **Price**. If you choose Calculated, it's assumed the calculation of the shipping option is handled using custom logic implemented in the Fulfillment provider.
|
||||
- **Price:** This field is only available and required when you set the **Price Type** to Flat Rate. It indicates the price of the shipping option.
|
||||
- **Shipping Profile (Required):** The shipping profile this option belongs to.
|
||||
- **Fulfillment Method (Required):** the fulfillment provider that will handle fulfilling this shipping option.
|
||||
- **Requirements:** You can use this section to specify a condition for when this shipping option should be available during checkout or draft-order creation. The "Min. subtotal" field indicates the minimum cart subtotal required to use this shipping option, and the "Max. subtotal" field indicates the maximum cart subtotal required to use this shipping option. For example, you can fill in the first field “100” to only allow using this shipping option if the cart’s subtotal is at least $100.
|
||||
- **Metadata**: This section allows you to add custom data to the shipping option in the form of a key-value pair. This is mostly helpful for technical teams and developers.
|
||||
6. Once you’re done, click the "Save and close" button.
|
||||
|
||||
### Edit a Shipping Option
|
||||
|
||||
To edit a shipping option:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Select the shipping option's region.
|
||||
3. Scroll down to the Shipping Options section on the right side.
|
||||
4. Find the shipping option you want to edit and click on the three dots icon at its right.
|
||||
5. Click on Edit in the dropdown.
|
||||
6. A new window will open with the fields that you can edit. You can edit all of the fields you chose while adding the shipping option except for the Shipping Profile and Fulfillment Method.
|
||||
7. Once you’re done, click the Save and close button.
|
||||
|
||||
### Delete a Shipping Option
|
||||
|
||||
:::warning
|
||||
|
||||
If you delete a shipping option, you can’t restore it or its data, customers can’t use it during checkout, and admins can’t use it for draft orders.
|
||||
|
||||
:::
|
||||
|
||||
To delete a shipping option:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Select the shipping option's region.
|
||||
3. Scroll down to the Shipping Options section on the right side.
|
||||
4. Find the shipping option you want to edit and click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at its right.
|
||||
5. Click on Delete in the dropdown.
|
||||
|
||||
---
|
||||
|
||||
## Manage Return Shipping Options in a Region
|
||||
|
||||
### Add Return Shipping Option to a Region
|
||||
|
||||
To add a return shipping option:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Select the shipping option's region.
|
||||
3. Scroll down to the Return Shipping Options section on the right side.
|
||||
4. Click on the Add Option button.
|
||||
5. A new window will open with a form with the following fields:
|
||||
- **Visible in Store:** Whether or not this option should be available on the website. This is useful if you want to create a return shipping option only for use on the Medusa Admin (for example, to create an order return).
|
||||
- **Title (Required):** The name of the shipping option. The customer will see this name on the storefront if the “Show on Website” field is checked.
|
||||
- **Price Type (Required):** The type of price. It can be either Flat Rate or Calculated. If you choose Flat Rate, this will show a new field **Price**. If you choose Calculated, it's assumed the calculation of the shipping option is handled using custom logic implemented in the Fulfillment provider.
|
||||
- **Price:** This field is only available and required when you set the **Price Type** to Flat Rate. It indicates the price of the shipping option.
|
||||
- **Shipping Profile (Required):** The shipping profile this option belongs to.
|
||||
- **Fulfillment Method (Required):** the fulfillment provider that will handle fulfilling this shipping option.
|
||||
- **Requirements:** You can use this section to specify a condition for when this shipping option should be available when creating a return or exchange. The "Min. subtotal" field indicates the minimum subtotal required to use this shipping option, and the "Max. subtotal" field indicates the maximum subtotal required to use this shipping option. For example, you can fill in the first field “100” to only allow using this shipping option if the cart’s subtotal is at least $100.
|
||||
- **Metadata**: This section allows you to add custom data to the shipping option in the form of a key-value pair. This is mostly helpful for technical teams and developers.
|
||||
6. Once you’re done, click the "Save and close" button.
|
||||
6. Once you’re done, click the Save and close button.
|
||||
|
||||
### Edit a Return Shipping Option
|
||||
|
||||
To edit a return shipping option:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Select the shipping option's region.
|
||||
3. Scroll down to the Return Shipping Options section on the right side.
|
||||
4. Find the shipping option you want to edit and click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at its right.
|
||||
5. Click on Edit in the dropdown.
|
||||
6. A new window will open with the fields that you can edit. You can edit all of the fields you chose while adding the shipping option except for the Shipping Profile and Fulfillment Method.
|
||||
7. Once you’re done, click the Save and close button.
|
||||
|
||||
### Delete a Return Shipping Option
|
||||
|
||||
:::warning
|
||||
|
||||
If you delete a return shipping option, you can’t restore it or its data, customers can’t use it when they request a return or an exchange, and admins can’t use it when requesting a return for an order or registering an exchange or claim for an order.
|
||||
|
||||
:::
|
||||
|
||||
To delete a return shipping option:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Select the shipping option's region.
|
||||
3. Scroll down to the Return Shipping Options section on the right side.
|
||||
4. Find the shipping option you want to edit and click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at its right.
|
||||
5. Click on Delete in the dropdown.
|
||||
Reference in New Issue
Block a user