chore: reorganize docs apps (#7228)

* reorganize docs apps

* add README

* fix directory

* add condition for old docs
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-05-03 17:36:38 +03:00
1 parent 224ebb2154
commit 4fe28f5a95
6187 files changed
+601447 -598226

No files matched your search

@@ -0,0 +1,37 @@
---
sidebar_position: 2
sidebar_label: "Manage Countries"
---
import { EllipsisHorizontal } from "@medusajs/icons"
export const metadata = {
title: `Manage Countries in a Region`,
}
# {metadata.title}
In this document, you'll learn how to manage countries in a region.
## Add Countries
To add a country to a region:
1. Go to Settings → Regions.
2. Click on the region you want to edit.
3. Under the Countries section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right.
4. Choose "Add countries" from the dropdown.
5. In the list that shows, check the checkboxes next to the countries you want to add.
6. Once you're done, click the Save button.
---
## Remove Countries
To remove countries from a region:
1. Go to Settings → Regions.
2. Click on the region you want to edit.
3. Under the Countries section, check the checkbox next to the countries you want to remove.
4. Once you're done, press <Kbd>R</Kbd>.
5. Confirm removing the country by typing "Remove" in the field and clicking the Remove button in the pop-up.
@@ -0,0 +1,83 @@
---
sidebar_position: 1
---
import { EllipsisHorizontal } from "@medusajs/icons"
export const metadata = {
title: `Manage Regions`,
}
# {metadata.title}
In this document, you’ll learn how to view and manage regions in your Medusa Admin.
## View Regions
To view your regions, go to Settings → Regions. You'll find a list of available regions in your store.
---
## Create a Region
To create a region:
1. Go to Settings → Regions.
2. Click the Create button.
3. In the form that opens:
1. Enter the region's name in the Name field.
2. Choose the region's currency in the Currency field. If you can't find a currency, make sure to [add it to the store first](../../store/page.mdx#add-currencies).
3. Enter the tax rate and, optionally, the tax code of the region.
4. Enable the "Tax inclusive pricing" field to specify that all prices of that region include taxes.
5. To add countries to the region:
1. Click the "Add countries" button.
2. In the list shown, check the checkbox next to the countries to add.
3. Once you're done, click the Save button.
6. Under the Providers section, select the available payment and fulfillment providers in the region.
4. Once you’re done, click on the Save button.
---
## Edit a Region
To edit a region's details:
1. Go to Settings → Regions.
2. Click on the region you want to edit.
3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
4. Choose Edit from the dropdown.
5. In the drawer that opens, edit the region's details.
6. Once done, click the Save button.
---
## Edit Region's Tax Settings
When you create a region, taxes settings are created for that region as well.
To view and edit a region's tax settings:
1. Go to Settings → Regions.
2. Click on the region you want to edit.
3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
4. Choose "Tax settings" from the dropdown.
This opens the taxes page of the region. Learn more about managing taxes in [this guide](../../taxes/manage/page.mdx).
---
## Delete a Region
<Note type="warning">
Deleting a region is irreversible.
</Note>
To delete a region:
1. Go to Settings → Regions.
2. Click on the region you want to delete.
3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
4. Choose Delete from the dropdown.
5. Confirm deleting the region by entering its name and clicking the Delete button in the pop-up.
@@ -0,0 +1,41 @@
---
sidebar_position: 4
---
export const metadata = {
title: `Regions`,
}
# {metadata.title}
In this document, you’ll get an overview of regions and learn about their importance in your commerce store.
## Overview
Regions are essential to your commerce store. You use regions to specify available currencies, payment providers, fulfillment providers, tax rates, and more for different regions.
Regions represent different countries that your commerce store serves customers in. A region can have multiple countries with the same settings, but a region can also be specific to a single country with its own settings.
---
## Currencies in Regions
Each region uses one currency, and you can set prices across your store for each region.
For example, when you create a product variant, you set the price of that variant for each currency and region in your store.
---
## How Customers Use Regions
When a customer browses your storefront, they choose the region based on their location. Then, the prices, shipping providers, payment providers, and taxes available and applied are 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/page.mdx)
- [Manage Payment and Fulfillment Providers](./providers/page.mdx)
- [Manage Shipping Options in a Region](./shipping-options/page.mdx)
@@ -0,0 +1,29 @@
---
sidebar_position: 3
sidebar_label: Manage Providers
---
import { EllipsisHorizontal } from "@medusajs/icons"
export const metadata = {
title: `Manage Payment and Fulfillment Providers in a Region`,
}
# {metadata.title}
In this document, you’ll learn how to manage a region’s payment and fulfillment providers in your Medusa Admin.
<Note>
Before customers can use your payment or fulfillment provider, you must add that provider to one or more region.
</Note>
To add or remove a payment or fulfillment provider in a region:
1. Go to Settings → Regions.
2. Click on the region you want to edit.
4. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
4. Choose Edit from the dropdown.
5. In the drawer that opens and under the Providers section, change the payment and fulfillment providers of the region.
6. Once you're done, click the Save button.
@@ -0,0 +1,74 @@
---
sidebar_position: 4
sidebar_label: Manage Shipping Options
---
import { EllipsisHorizontal } from "@medusajs/icons"
export const metadata = {
title: `Manage Shipping Options in a Region`,
}
# {metadata.title}
In this document, you’ll learn how to manage a region’s shipping options in your Medusa Admin.
## What is a Shipping Option?
A shipping option has two types:
- **Outbound**: these options are used in customers' orders. During checkout, a customer chooses one of these shipping options to receive their order. These shipping options are used when you create draft orders as well.
- **Return**: these options are used when the customer returns an item, whether the return is requested by the customer or the admin user.
---
## Create a Shipping Option
To create a shipping option in a region:
1. Go to Settings → Regions.
2. Under the Shipping Options section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the section.
3. Choose Create from the dropdown.
4. In the form that opens:
1. Under the Type section, choose the shipping option's type.
2. To only show and use the shipping option in the admin dashboard, enable the "Admin only" field.
3. To specify that the shipping option's price is tax-inclusive, enable the "Tax inclusive pricing" field.
4. Specify the shipping option's name in the Name field. This name is shown to customers if "Admin only" is disabled.
5. For the Price Type field, specify the shipping option's price type:
- **Flat rate**: The shipping option has a fixed price. In this case, you must enter the shipping option's price in the Price field.
- **Calculated**: The shipping option's price is calculated, meaning that the amount is shown while placing the order or creating the return.
6. For the Shipping Profile field, specify the profile of the items that this shipping option can be used with:
- For gift cards, choose Gift Card Profile.
- For all other products, choose Default Shipping Profile.
7. For the Fulfillment Provider field, choose the region's fulfillment provider used to handle the fulfillment and shipping when this shipping option is used. If you can't find a fulfillment provider, make sure to [add it to the region first](../providers/page.mdx).
8. Under the Requirements section, you can specify a minimum and maximum cart subtotal amount. When specified, the shipping option can only be used when this condition is met.
5. Once you're done, click the Save button.
---
## Edit a Shipping Option
To edit a shipping option in a region:
1. Go to Settings → Regions.
2. Under the Shipping Options section, find the shipping option to edit and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> at its right.
3. Choose Edit from the dropdown.
4. In the drawer, edit any of the shipping option's details.
5. Once you're done, click the Save button.
---
## Delete a Shipping Option
<Note type="warning">
Deleting a shipping option is irreversible.
</Note>
To delete a shipping option in a region:
1. Go to Settings → Regions.
2. Under the Shipping Options section, find the shipping option to delete and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> at its right.
3. Choose Delete from the dropdown.
4. Confirm deleting the shipping option by clicking the Delete button in the pop-up.