Files
medusa-store/www/apps/docs/content/user-guide.mdx
Shahed Nasser c6dff873de docs: update docusaurus to v3 (#5625)
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
2023-11-13 20:11:50 +02:00

74 lines
4.1 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
sidebar_position: 1
description: 'The user guide explains how to use the Medusa Admin for non technical users. Learn through easy steps how to use the Medusa admin to perform different operations and ecommerce tasks.'
---
import UiIcon from '@site/src/components/UiIcon';
# Welcome to Medusas User Guide
This user guide is intended to help users learn how they can use the Medusa admin to perform different operational and ecommerce tasks.
![Medusa Admin Overview](https://res.cloudinary.com/dza7lstvk/image/upload/v1697793701/Medusa%20Docs/User%20Guide/Screenshot_2023-10-20_at_12.21.19_PM_lqcurg.png)
## Accessing the Medusa Admin
To access the admin panel of your ecommerce store, you must have a URL to the deployed website.
Once you open the URL, youll be asked to log in.
![Log In Page](https://res.cloudinary.com/dza7lstvk/image/upload/v1680249817/Medusa%20Docs/User%20Guide/Screenshot_2023-03-31_at_11.02.49_AM_uiv0hl.png)
You must use your users email and password to log in. If youre unsure what your email and password are, please contact the technical personnel that deployed your Medusa backend and admin.
## Tour of Medusa Admin
After you log into your Medusa admin, you can see a sidebar menu, a search bar at the top, some icons at the top right, and in the middle the content of the page youre currently on.
### Sidebar Menu
The sidebar menu includes the main navigation of your Medusa admin. You can use it to navigate between different pages, such as Products or Orders pages.
![Sidebar Menu](https://res.cloudinary.com/dza7lstvk/image/upload/v1697793775/Medusa%20Docs/User%20Guide/Screenshot_2023-10-20_at_12.22.43_PM_shbr0e.png)
### Search Bar
Youll find at the top of the page a search bar. You can use this search bar to search orders, products, customers, and more information available in your Medusa Admin.
:::info
You can open the search window using the shortcuts:
Windows and Linux: <kbd>CTRL</kbd> + <kbd>K</kbd>
Mac OS: <kbd>⌘</kbd> + <kbd>K</kbd>
:::
![Search Window](https://res.cloudinary.com/dza7lstvk/image/upload/v1697793970/Medusa%20Docs/User%20Guide/Screenshot_2023-10-20_at_12.26.00_PM_e8sney.png)
You can select a result with your mouse. Alternatively, use the up and down arrows on your keyboard to navigate between the results, then choosing a result by hitting the Enter key.
### Check Notifications
At the top right youll find a <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999044/Medusa%20Docs/UI%20Icons/tE8LOXk_puyrib.png" alt="bell" /> icon. Clicking this icon opens a side window to view any notifications you might have. You can use this to view notifications such as completed product exports.
![Notifications Window](https://res.cloudinary.com/dza7lstvk/image/upload/v1667924034/Medusa%20Docs/User%20Guide/cTIu9yP_ubsbqx.png)
### Change Language
The Medusa admin supports multiple-languages, with English being the default one.
Learn how to change the language in [this guide](./user-guide/users/profile.md#change-admin-language).
### Quick Actions
At the top left in the sidebar, youll find an avatar icon. By clicking this icon, youll see a dropdown. You can use this dropdown to access settings or sign out.
![Quick Actions Dropdown](https://res.cloudinary.com/dza7lstvk/image/upload/v1697794317/Medusa%20Docs/User%20Guide/Screenshot_2023-10-20_at_12.31.37_PM_wioczx.png)
### Need Help
At the top right, youll find a <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999071/Medusa%20Docs/UI%20Icons/CrABja9_lwomxs.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999095/Medusa%20Docs/UI%20Icons/cgeX2hP_b1vkwy.png" alt="question mark" /> icon. When you click on this icon, a form will pop up. You can use this form to send the Medusa team a message asking for help. The Medusa team usually responds in a few hours on business days.
![Get Help Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1697794650/Medusa%20Docs/User%20Guide/Screenshot_2023-10-20_at_12.37.19_PM_vbatec.png)