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": 4,
|
||||
"collapsed": false,
|
||||
"link": null,
|
||||
"label": "Customers",
|
||||
"customProps": {
|
||||
"sidebar_is_group_headline": true
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,113 @@
|
||||
---
|
||||
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';
|
||||
|
||||
# Manage Customer Groups
|
||||
|
||||
In this document, you’ll learn how to manage customer groups, including customers in these groups.
|
||||
|
||||
## Create a Customer Group
|
||||
|
||||
To create a customer group:
|
||||
|
||||
1. Go to the Customers page.
|
||||
2. Choose the Groups headline.
|
||||
3. Click on the New Group button.
|
||||
4. In the pop-up that opens:
|
||||
1. Enter a title for the group.
|
||||
2. Under Metadata, you can optionally attach custom data to the customer group as key-value pairs. This is mostly useful for technical teams and develoeprs.
|
||||
5. Once you’re done, click on the Publish Group button.
|
||||
|
||||
---
|
||||
|
||||
## View Customer Group Details
|
||||
|
||||
To view the details of a customer group:
|
||||
|
||||
1. Go to the Customers page.
|
||||
2. Choose the Groups headline.
|
||||
3. Click on the name of the group you want to view.
|
||||
|
||||
---
|
||||
|
||||
## Edit a Customer Group
|
||||
|
||||
To edit a customer group:
|
||||
|
||||
1. Go to the customer group’s details page.
|
||||
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 at the top right of the first section.
|
||||
3. Click on Edit in the dropdown.
|
||||
4. In the pop-up that opens:
|
||||
1. You can change the title and existing metadata of the group.
|
||||
2. Under Metadata, you can optionally attach custom data to the customer group as key-value pairs. This is mostly useful for technical teams and develoeprs.
|
||||
5. Once you’re done, click on the Edit Group button.
|
||||
|
||||
---
|
||||
|
||||
## Manage Customers in a Group
|
||||
|
||||
### View List of Customers in a Group
|
||||
|
||||
To view the list of customers in a customer group:
|
||||
|
||||
1. Go to the customer group’s details page.
|
||||
2. Scroll to the Customers section. You’ll find all customers that belong to this customer group in this section if there are any.
|
||||
|
||||
### Add Customers to a Group
|
||||
|
||||
To add customers to a customer group:
|
||||
|
||||
1. Go to the customer group’s details page.
|
||||
2. Click on the “Edit customers” button at the top right of the Customers section.
|
||||
3. Check the box next to every customer you want to add to the group.
|
||||
4. Click on the Save button.
|
||||
|
||||
### Remove a Customer from a Group
|
||||
|
||||
:::info
|
||||
|
||||
Removing customers from a customer group doesn't remove the customers from your store.
|
||||
|
||||
:::
|
||||
|
||||
To remove customers from a customer group:
|
||||
|
||||
1. Go to the customer group’s details page.
|
||||
2. In the Customer 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 next to the customer you want to remove from the group.
|
||||
3. Click on “Delete from the Group” from the dropdown.
|
||||
|
||||
### Remove Multiple Customers from a Group
|
||||
|
||||
:::info
|
||||
|
||||
Removing customers from a customer group doesn't remove the customers from your store.
|
||||
|
||||
:::
|
||||
|
||||
To remove more than one customer from a customer group at the same time:
|
||||
|
||||
1. Go to the customer group’s details page.
|
||||
2. Click on the “Edit customers” button at the top right of the Customers section.
|
||||
3. Uncheck the box next to every customer you want to remove from the group.
|
||||
4. Click on the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Delete Customer Group
|
||||
|
||||
:::warning
|
||||
|
||||
Deleting a customer group cannot be undone.
|
||||
|
||||
:::
|
||||
|
||||
To delete a customer group:
|
||||
|
||||
1. Go to the customer group’s details page.
|
||||
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 at the top right of the first section.
|
||||
3. Click on Delete from the dropdown.
|
||||
4. Confirm deleting the customer group by clicking the “Yes, delete” button in the pop-up.
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: 'Medusa admin allows merchants to manage customers and customer groups.'
|
||||
---
|
||||
|
||||
# Customers Overview
|
||||
|
||||
In this document, you’ll get an overview of the customer listing page and all the things you can do with it.
|
||||
|
||||
## Overview
|
||||
|
||||
You can find the list of signed up customers on your store in the Customers page. For each of those customers, you can view details such as their orders, or personal information.
|
||||
|
||||
Part of the Customers domain is also Customer Groups. Customer groups allow you to put together a set of customers for business purposes. For example, you can create a VIP customer group for customers that you want to give special discounts.
|
||||
|
||||
---
|
||||
|
||||
## View List of Customers
|
||||
|
||||
You can view the list of available customers in your ecommerce store by clicking on Customers from the sidebar menu.
|
||||
|
||||
In the list, you can see customer details such as the customer’s name, email address, and the number of orders.
|
||||
|
||||
---
|
||||
|
||||
## View List of Customer Groups
|
||||
|
||||
You can view the list of customer groups on the Customer Groups page by clicking on the grey Groups headline next to the Customers headline.
|
||||
|
||||
In the list, you can see group details such as the group’s title and the number of customers in the group.
|
||||
|
||||
---
|
||||
|
||||
## Learn More About Customers
|
||||
|
||||
- [Manage and View a Customer’s Details](./manage.mdx)
|
||||
- [Manage and View a Customer Group](./groups.mdx)
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
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';
|
||||
|
||||
# Manage Customers
|
||||
|
||||
In this document, you’ll learn how to manage customers and their details.
|
||||
|
||||
## View Customer Details
|
||||
|
||||
To view a customer’s details:
|
||||
|
||||
1. Go to the Customers page.
|
||||
2. Click on the customer you want to view.
|
||||
|
||||
---
|
||||
|
||||
## Edit Customer Details
|
||||
|
||||
To edit a customer’s details:
|
||||
|
||||
1. Go to a Customer’s details page.
|
||||
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 in the first section.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the pop-up that opens, you can edit the customer’s details.
|
||||
5. Once you’re done, click on the "Save and close" button.
|
||||
|
||||
---
|
||||
|
||||
## View Customer Orders
|
||||
|
||||
To view the orders of a customer:
|
||||
|
||||
1. Go to a Customer’s details page.
|
||||
2. Scroll to the Orders section. You’ll fine the customer’s orders and you can click on an order to view it.
|
||||
Reference in New Issue
Block a user