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,12 @@
|
||||
{
|
||||
"position": 13,
|
||||
"collapsed": false,
|
||||
"link": null,
|
||||
"label": "Settings",
|
||||
"customProps": {
|
||||
"sidebar_is_group_headline": true,
|
||||
"customProps": {
|
||||
"sidebar_is_group_headline": true
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,61 @@
|
||||
---
|
||||
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
|
||||
|
||||
In this document, you’ll learn how to set the default currency in your store and how to support more currencies.
|
||||
|
||||
## Overview
|
||||
|
||||
Medusa supports using more than one currency in your store. When you add currencies, you can set prices for products for each of those currencies.
|
||||
|
||||
To make a currency available for your customers, you have to use the currency in a region. Then, your customers will be able to choose the region with the currency that fits them.
|
||||
|
||||
:::tip
|
||||
|
||||
Before you can use a currency in a region, make sure to [add it to your store](#add-a-currency).
|
||||
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Add a Currency
|
||||
|
||||
To make a currency available in your store:
|
||||
|
||||
1. Go to Settings → Currencies.
|
||||
2. Click on the “Edit currencies” button in the Store Currencies section.
|
||||
3. In the new window that opens:
|
||||
1. Click on the Add Currencies button.
|
||||
2. Select all the currencies you want to add.
|
||||
4. Click on the “Save and close” button.
|
||||
|
||||
---
|
||||
|
||||
## Set Default Currency
|
||||
|
||||
:::tip
|
||||
|
||||
Before you can make a currency the default currency, make sure to [add it to your store](#add-a-currency).
|
||||
|
||||
:::
|
||||
|
||||
To set the default currency of your store:
|
||||
|
||||
1. Go to Settings → Currencies.
|
||||
2. In the "Default store currency” section, choose from the dropdown the currency you want to make the default.
|
||||
|
||||
---
|
||||
|
||||
## Remove Currencies
|
||||
|
||||
To remove a currency from your store:
|
||||
|
||||
1. Go to Settings → Currencies.
|
||||
2. Click on the “Edit currencies” button in the Store Currencies section.
|
||||
3. In the new window that opens:
|
||||
1. Select all the currencies you want to remove.
|
||||
2. Click on the Remove button.
|
||||
@@ -0,0 +1,118 @@
|
||||
---
|
||||
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';
|
||||
|
||||
# Manage Publishable API Keys
|
||||
|
||||
In this document, you’ll learn how to manage publishable API keys in Medusa Admin.
|
||||
|
||||
## Overview
|
||||
|
||||
Publishable API keys are used by developers or technical teams. They are used to define the resources that an API key is associated with and can access.
|
||||
|
||||
Then, this publishable API key is used in storefront development to retrieve or process data based on the scope of the publishable API key.
|
||||
|
||||
Currently, publishable API keys can only be used with sales channels.
|
||||
|
||||
---
|
||||
|
||||
## Create Publishable API Key
|
||||
|
||||
To create a publishable API key:
|
||||
|
||||
1. Go to Settings → API key management.
|
||||
2. Click on the “Create API key” button at the top right.
|
||||
3. In the new form that opens:
|
||||
1. Enter a name for the API key in the Title field.
|
||||
2. You can optionally add sales channels. To do that:
|
||||
1. Click on the “Add sales channels” button.
|
||||
2. Click on the checkbox next to the sales channels you want to add.
|
||||
3. Click on the “Save and close” button.
|
||||
4. Once you’re done, click on the “Publish API key” button.
|
||||
|
||||
---
|
||||
|
||||
## Copy Token of API Key
|
||||
|
||||
To copy the token of an API key:
|
||||
|
||||
1. Go to Settings → API key management.
|
||||
2. 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 next to the API key you want to copy.
|
||||
3. Click on “Copy token” from the dropdown.
|
||||
|
||||
---
|
||||
|
||||
## Edit API Key Details
|
||||
|
||||
To edit the details of an API key:
|
||||
|
||||
1. Go to Settings → API key management.
|
||||
2. 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 next to the API key you want to edit.
|
||||
3. Click on “Edit API key details” from the dropdown.
|
||||
4. Change the title of the API Key in the side window that opens.
|
||||
5. Click on the “Save and close” button.
|
||||
|
||||
---
|
||||
|
||||
## Manage Sales Channels of a Publishable API Key
|
||||
|
||||
:::info
|
||||
|
||||
Making any changes in the sales channels here does not affect the sales channel itself or any of its data. This only impacts the relation between sales channels and publishable API keys.
|
||||
|
||||
:::
|
||||
|
||||
You can add or delete sales channels from a publishable API key. Adding a sales channel makes it accessible using the publishable API key. Removing a sales channel from a publishable API key removes the API key’s access to the sales channel.
|
||||
|
||||
To manage sales channels of a publishable API key:
|
||||
|
||||
1. Go to Settings → API key management.
|
||||
2. 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 next to the API key you want to manage its sales channels.
|
||||
3. Click on “Edit sales channels” from the dropdown.
|
||||
4. In the side window that opens:
|
||||
1. To add a sales channel to the publishable API key:
|
||||
1. Click on the “Add channels” button.
|
||||
2. Click on the checkbox next to the sales channels you want to add.
|
||||
3. Once done, click on the “Add and go back” button to add the sales channels and continue editing, or click on the “Add and close” to add the sales channels and close the side menu.
|
||||
2. To delete a sales channel from the publishable API key:
|
||||
1. Click on the checkbox next to the sales channels you want to delete.
|
||||
2. Click on the “Remove” button.
|
||||
5. Once you’re done editing, click on the Close button.
|
||||
|
||||
---
|
||||
|
||||
## Revoke Publishable API Key
|
||||
|
||||
:::warning
|
||||
|
||||
Revoking a publishable API key does not remove it, but the API key can’t be used in development anymore. It can't be undone.
|
||||
|
||||
:::
|
||||
|
||||
To revoke a publishable API key:
|
||||
|
||||
1. Go to Settings → API key management.
|
||||
2. 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 next to the API key you want to revoke.
|
||||
3. Click on “Revoke token” from the dropdown.
|
||||
4. Confirm revoking the publishable API key by clicking the “Yes, revoke” button in the pop-up.
|
||||
|
||||
---
|
||||
|
||||
## Delete Publishable API Key
|
||||
|
||||
:::warning
|
||||
|
||||
Deleting a publishable API key completely removes it and the API key can’t be used in development anymore. It can't be undone.
|
||||
|
||||
:::
|
||||
|
||||
To delete a publishable API key:
|
||||
|
||||
1. Go to Settings → API key management.
|
||||
2. 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 next to the API key you want to delete.
|
||||
3. Click on “Delete API key” from the dropdown.
|
||||
4. Confirm deleting the publishable API key by clicking the “Yes, delete” button in the pop-up.
|
||||
@@ -0,0 +1,66 @@
|
||||
---
|
||||
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';
|
||||
|
||||
# Manage Return Reasons
|
||||
|
||||
In this document, you’ll learn how to add, edit, and remove return reasons.
|
||||
|
||||
## Overview
|
||||
|
||||
Return reasons are used when issuing returns or exchanges of orders. When you want to request an exchange or return of an item in an order, you must specify the reason for that return.
|
||||
|
||||
Return reasons are custom and are created by merchants. For example, you can create the return reason “damaged”, then use it when you want to request a return for an item in an order because it has been damaged.
|
||||
|
||||
:::note
|
||||
|
||||
Creating at least one return reason is required before you can handle order returns and exchanges.
|
||||
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Add Return Reason
|
||||
|
||||
To add a return reason:
|
||||
|
||||
1. Go to Settings → Return Reasons.
|
||||
2. Click on the “Add reason” button in the Return Reasons section.
|
||||
3. In the new window:
|
||||
1. You are required to enter a value and a label for the return reason. The value is for internal use and must not include spaces. The label is what the customer will see in their order returns or exchanges.
|
||||
2. You can optionally enter a description for the return reason.
|
||||
4. Once done, click on the Create button.
|
||||
|
||||
---
|
||||
|
||||
## Duplicate a Return Reason
|
||||
|
||||
To duplicate a return reason:
|
||||
|
||||
1. Go to Settings → Return Reasons.
|
||||
2. Choose the return reason you want to duplicate from the left section.
|
||||
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 Details section.
|
||||
4. Click on “Duplicate reason” from the dropdown.
|
||||
5. In the new window that opens, make changes as necessary for the new return reason.
|
||||
6. Once done, click on the Create button.
|
||||
|
||||
---
|
||||
|
||||
## Edit a Return Reason
|
||||
|
||||
:::info
|
||||
|
||||
A return reason’s value can’t be edited.
|
||||
|
||||
:::
|
||||
|
||||
To edit a return reason:
|
||||
|
||||
1. Go to Settings → Return Reasons.
|
||||
2. Choose the return reason you want to edit from the left section.
|
||||
3. In the Details section, make changes to the label or description of the return reason.
|
||||
4. Once done, click on the Save button.
|
||||
@@ -0,0 +1,21 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: 'This user guide explains how to manage the store details on the Medusa admin.'
|
||||
---
|
||||
|
||||
# Manage Store Details
|
||||
|
||||
In this document, you’ll learn how to edit the store’s details.
|
||||
|
||||
## Edit Store Details
|
||||
|
||||
To edit the store’s details:
|
||||
|
||||
1. Go to Settings → Store Details
|
||||
2. In the Store Details form:
|
||||
1. You can change the store’s name.
|
||||
2. You can set the template link for swaps, draft orders, and invites. When making a change to the link template, make sure to use the following placeholders within the link:
|
||||
1. **Swaps**: Use the `{swap_id}` placeholder to indicate where the ID of the swap should be in the link.
|
||||
2. **Draft Order**: Use the `{payment_id}` placeholder to indicate where the ID of the payment should be in the link.
|
||||
3. **Invites:** Use the `{invite_token}` placeholder to indicate where the invite token should be in the link.
|
||||
3. Once done, click on the Save button.
|
||||
Reference in New Issue
Block a user