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": 11,
|
||||
"collapsed": false,
|
||||
"link": null,
|
||||
"label": "Sales Channels",
|
||||
"customProps": {
|
||||
"sidebar_is_group_headline": true
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,63 @@
|
||||
---
|
||||
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.
|
||||
|
||||
## 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.
|
||||
|
||||
By default, there’s a default sales channel in a Medusa store. You can add multiple sales channels.
|
||||
|
||||
---
|
||||
|
||||
## How Sales Channels Work
|
||||
|
||||
Sales channels are associated with data and settings in your ecommerce store.
|
||||
|
||||
For each sales channel, you can choose which products belong to that sales channel. A product can be available in more than one sales channel.
|
||||
|
||||
Then, when customers place an order from a sales channel, the order is associated with that sales channel. You’ll be able to see the sales channel an order was placed from in the Medusa admin.
|
||||
|
||||
---
|
||||
|
||||
## Sales Channels Settings Overview
|
||||
|
||||
To view the available sales channels and settings, go to Settings → Sales channels.
|
||||
|
||||
In the sales channels settings page, You can view available sales channels, add more sales channels, edit sales channels, and manage products available in the sales channel.
|
||||
|
||||
---
|
||||
|
||||
## View Sales Channels of Orders
|
||||
|
||||
### Orders Page
|
||||
|
||||
In the Orders page, you can see the sales channel an order belongs to. If the order doesn’t belong to any sales channel, you can see “N/A” instead.
|
||||
|
||||
### Orders Details Page
|
||||
|
||||
In the details page of an order, you can find the sales channel the order belongs to, if there are any.
|
||||
|
||||
---
|
||||
|
||||
## View Sales Channels of Products
|
||||
|
||||
### Products Page
|
||||
|
||||
In the Products page, you can see the sales channels a product belongs to under the Availability column if there are any.
|
||||
|
||||
### Products Edit Page
|
||||
|
||||
In the edit page of a product, you can find the sales channels the product belongs to and edit them under the Sales Channels section.
|
||||
|
||||
---
|
||||
|
||||
## Learn More About Sales Channels
|
||||
|
||||
- [Manage Sales Channels](./manage.mdx)
|
||||
- [Manage Products in Sales Channels](./products.mdx)
|
||||
@@ -0,0 +1,90 @@
|
||||
---
|
||||
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';
|
||||
|
||||
# Manage Sales Channels
|
||||
|
||||
In this document, you’ll learn how to view and manage sales channels in your Medusa Admin.
|
||||
|
||||
## View Sales Channels
|
||||
|
||||
To view sales channels:
|
||||
|
||||
1. Click on Settings in the sidebar.
|
||||
2. Choose Sales Channels from the list of settings.
|
||||
|
||||
This opens the Sales Channels page where you can see the list of Sales channels on the left and the products in the selected sales channel on the right.
|
||||
|
||||
---
|
||||
|
||||
## Search Sales Channels
|
||||
|
||||
To search sales channels:
|
||||
|
||||
1. Go to Settings → Sales Channels
|
||||
2. In the Sales Channels section on the left, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999227/Medusa%20Docs/UI%20Icons/k0U0wpO_pizpfd.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999249/Medusa%20Docs/UI%20Icons/IdKjFak_ultvmh.png" alt="magnifier" /> icon next to the title of the section.
|
||||
3. This shows an input to search sales channels by title and description.
|
||||
|
||||
To clear the search, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999180/Medusa%20Docs/UI%20Icons/kvGRHQR_s0ptsm.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999200/Medusa%20Docs/UI%20Icons/RJ4SLIu_n30zqr.png" alt="X" /> icon in the search input.
|
||||
|
||||
---
|
||||
|
||||
## Create a Sales Channel
|
||||
|
||||
To add a new sales channel:
|
||||
|
||||
1. Go to Settings → Sales Channels
|
||||
2. In the Sales Channels section on the left, 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 next to the title of the section.
|
||||
3. The form to create a new sales channel will open. The name of the sales channel is required, but the description is optional.
|
||||
4. Once you’re done, you can either:
|
||||
- Click Save as draft to save the sales channel as disabled.
|
||||
- Click Publish channel to save the sales channel as enabled.
|
||||
|
||||
---
|
||||
|
||||
## Change the Status of a Sales Channel
|
||||
|
||||
A sales channel can be enabled or disabled. If a sales channel is disabled, that means it’s saved as a draft. If it’s enabled, that means it’s published.
|
||||
|
||||
To enable or disable a sales channel:
|
||||
|
||||
1. Go to Settings → Sales Channels
|
||||
2. In the sales channels list on the left, choose the sales channel you want to enable/disable.
|
||||
3. At the top right of the right section, you can find the status of the sales channel, with a <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999685/Medusa%20Docs/UI%20Icons/yrTcDO4_tulwph.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999685/Medusa%20Docs/UI%20Icons/yrTcDO4_tulwph.png" alt="green" /> icon if it’s enabled or a <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999700/Medusa%20Docs/UI%20Icons/0lUln3B_arpgmo.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999700/Medusa%20Docs/UI%20Icons/0lUln3B_arpgmo.png" alt="grey" /> icon if it’s disabled.
|
||||
4. Click on the status, and a dropdown will show to toggle the status. For example, if the status of the sales channel is Enabled, the dropdown will show a Disabled status.
|
||||
5. Choose the status in the dropdown, and the status of the sales channel will change.
|
||||
|
||||
---
|
||||
|
||||
## Edit Sales Channel’s Information
|
||||
|
||||
To edit a sales channel’s information:
|
||||
|
||||
1. Go to Settings → Sales Channels
|
||||
2. In the sales channels list on the left, choose the sales channel you want to edit.
|
||||
3. At the top right of the right section, 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 from the dropdown list “Edit general info”.
|
||||
5. This opens a form in a window where you can edit the name and description of the sales channel.
|
||||
6. Once done, click Save.
|
||||
|
||||
---
|
||||
|
||||
## Delete a Sales Channel
|
||||
|
||||
:::warning
|
||||
|
||||
If you delete a sales channel, you won’t be able to restore it. Orders and Products associated with the sales channel will not be affected.
|
||||
|
||||
:::
|
||||
|
||||
To delete a sales channel:
|
||||
|
||||
1. Go to Settings → Sales Channels
|
||||
2. In the sales channels list on the left, choose the sales channel you want to delete.
|
||||
3. At the top right of the right section, 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 from the dropdown list “Delete channel”.
|
||||
5. Confirm deleting the sales channel by entering the name of the sales channel and clicking the “Yes, delete” button in the pop-up.
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
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';
|
||||
|
||||
# Manage Products in Sales Channels
|
||||
|
||||
In this document, you’ll learn how to manage products in Sales Channels.
|
||||
|
||||
:::note
|
||||
|
||||
This guide covers managing products from the Sales Channels page. It’s also possible to manage the Sales Channels of products in the Products page.
|
||||
|
||||
:::
|
||||
|
||||
## Add Products to Sales Channels
|
||||
|
||||
To add products to a sales channel:
|
||||
|
||||
1. Go to Settings → Sales Channels
|
||||
2. In the sales channels list on the left, choose the sales channel you want to add products to.
|
||||
3. At the top right of the right section, 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 from the dropdown list “Add products”.
|
||||
5. This opens a window to add products with filters and search functionalities similar to those of a product page. Select the products you want to add to the sales channel.
|
||||
6. Click Save.
|
||||
|
||||
:::info
|
||||
|
||||
Products in the list that are grayed out are products that are already added to the sales channel.
|
||||
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Remove Product from Sales Channel
|
||||
|
||||
:::info
|
||||
|
||||
If you remove a product from a sales channel, it will still be available in your ecommerce store, just not in that sales channel. You can also add the product again to the sales channel.
|
||||
|
||||
:::
|
||||
|
||||
To remove a product from a sales channel:
|
||||
|
||||
1. Go to Settings → Sales Channels
|
||||
2. In the sales channels list on the left, choose the sales channel you want to remove the product from.
|
||||
3. Find the product you want to remove from the sales channel.
|
||||
4. Click 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 right side of the product’s row.
|
||||
5. Choose from the dropdown list “Remove from the channel”.
|
||||
Reference in New Issue
Block a user