fa7c94b4cc
* 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
80 lines
4.2 KiB
Plaintext
80 lines
4.2 KiB
Plaintext
---
|
||
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 Medusa’s 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 don’t have a Medusa admin yet, you can check [the live demo](https://demo.medusajs.com/)!
|
||
|
||
:::
|
||
|
||
|
||
|
||
## 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, you’ll be asked to log in.
|
||
|
||
|
||
|
||
You must use your user’s email and password to log in. If you’re 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 you’re 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.
|
||
|
||
|
||
|
||
### Search Bar
|
||
|
||
You’ll 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>
|
||
|
||
:::
|
||
|
||
|
||
|
||
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 you’ll 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.
|
||
|
||
|
||
|
||
### 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, you’ll find an avatar icon. By clicking this icon, you’ll see a dropdown. You can use this dropdown to access settings or sign out.
|
||
|
||
|
||
|
||
### Need Help
|
||
|
||
At the top right, you’ll 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.
|
||
|
||
 |