Files
medusa-store/docs/content/user-guide.mdx
Shahed Nasser 1decaa27c7 docs: publish restructure (#3496)
* docs: added features and guides overview page

* added image

* added version 2

* added version 3

* added version 4

* docs: implemented new color scheme

* docs: redesigned sidebar (#3193)

* docs: redesigned navbar for restructure (#3199)

* docs: redesigned footer (#3209)

* docs: redesigned cards (#3230)

* docs: redesigned admonitions (#3231)

* docs: redesign announcement bar (#3236)

* docs: redesigned large cards (#3239)

* docs: redesigned code blocks (#3253)

* docs: redesigned search modal and page (#3264)

* docs: redesigned doc footer (#3268)

* docs: added new sidebars + refactored css and assets (#3279)

* docs: redesigned api reference sidebar

* docs: refactored css

* docs: added code tabs transition

* docs: added new sidebars

* removed unused assets

* remove unusued assets

* Fix deploy errors

* fix incorrect link

* docs: fixed code responsivity + missing icons (#3283)

* docs: changed icons (#3296)

* docs: design fixes to the sidebar (#3297)

* redesign fixes

* docs: small design fixes

* docs: several design fixes after restructure (#3299)

* docs: bordered icon fixes

* docs: desgin fixes

* fixes to code blocks and sidebar scroll

* design adjustments

* docs: restructured homepage (#3305)

* docs: restructured homepage

* design fixes

* fixed core concepts icon

* docs: added core concepts page (#3318)

* docs: restructured homepage

* design fixes

* docs: added core concepts page

* changed text of different components

* docs: added architecture link

* added missing prop for user guide

* docs: added regions overview page (#3327)

* docs: added regions overview

* moved region pages to new structure

* docs: fixed description of regions architecture page

* small changes

* small fix

* docs: added customers overview page (#3331)

* docs: added regions overview

* moved region pages to new structure

* docs: fixed description of regions architecture page

* small changes

* small fix

* docs: added customers overview page

* fix link

* resolve link issues

* docs: updated regions architecture image

* docs: second-iteration fixes (#3347)

* docs: redesigned document

* design fixes

* docs: added products overview page (#3354)

* docs: added carts overview page (#3363)

* docs: added orders overview (#3364)

* docs: added orders overview

* added links in overview

* docs: added vercel redirects

* docs: added soon badge for cards (#3389)

* docs: resolved feedback changes + organized troubleshooting pages (#3409)

* docs: resolved feedback changes

* added extra line

* docs: changed icons for restructure (#3421)

* docs: added taxes overview page (#3422)

* docs: added taxes overview page

* docs: fix sidebar label

* added link to taxes overview page

* fixed link

* docs: fixed sidebar scroll (#3429)

* docs: added discounts overview (#3432)

* docs: added discounts overview

* fixed links

* docs: added gift cards overview (#3433)

* docs: added price lists overview page (#3440)

* docs: added price lists overview page

* fixed links

* docs: added sales channels overview page (#3441)

* docs: added sales overview page

* fixed links

* docs: added users overview (#3443)

* docs: fixed sidebar border height (#3444)

* docs: fixed sidebar border height

* fixed svg markup

* docs: added possible solutions to feedback component (#3449)

* docs: added several overview pages + restructured files (#3463)

* docs: added several overview pages

* fixed links

* docs: added feature flags + PAK overview pages (#3464)

* docs: added feature flags + PAK overview pages

* fixed links

* fix link

* fix link

* fixed links colors

* docs: added strategies overview page (#3468)

* docs: automated upgrade guide (#3470)

* docs: automated upgrade guide

* fixed vercel redirect

* docs: restructured files in docs codebase (#3475)

* docs: restructured files

* docs: fixed eslint exception

* docs: finished restructure loose-ends (#3493)

* fixed uses of backend

* docs: finished loose ends

* eslint fixes

* fixed links

* merged master

* added update instructions for v1.7.12
2023-03-16 17:03:10 +02:00

74 lines
3.9 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.
:::tip
If you dont have a Medusa admin yet, you can check [the live demo](https://demo.medusajs.com/)!
:::
![Medusa Admin Overview](https://res.cloudinary.com/dza7lstvk/image/upload/v1673455647/Medusa%20Docs/User%20Guide/Screenshot_2023-01-11_at_6.46.06_PM_sirvel.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/v1667923937/Medusa%20Docs/User%20Guide/cUYLszZ_bksyzs.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/v1673455798/Medusa%20Docs/User%20Guide/Screenshot_2023-01-11_at_6.49.48_PM_bj2bik.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 Handy Shortcut
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/v1667923987/Medusa%20Docs/User%20Guide/z9a1NLK_ojyfn0.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)
### 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/v1673455879/Medusa%20Docs/User%20Guide/Screenshot_2023-01-11_at_6.50.52_PM_tfduvw.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/v1667924070/Medusa%20Docs/User%20Guide/8Fpa0gr_sjovih.png)