6adaf56c73
* added value rules * resolved errors raised by vale * added github action * fixes to github action * added details in contribution guidelines * added rule for numbers * limited checks to errors
76 lines
3.0 KiB
Plaintext
76 lines
3.0 KiB
Plaintext
---
|
||
sidebar_position: 1
|
||
sidebar_label: Introduction
|
||
---
|
||
|
||
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 server 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.
|
||
|
||
You can also see your team members in the sidebar menu. These are the users that can access the Medusa Admin.
|
||
|
||
|
||
|
||
### 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 either select a resolve with your mouse, or 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://i.imgur.com/mWhpxNX.png" darkIcon="https://i.imgur.com/tE8LOXk.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.
|
||
|
||
|
||
|
||
### Quick Actions
|
||
|
||
At the top right, you’ll find an avatar icon. By clicking this icon, you’ll see a dropdown. You can use this dropdown to quickly access settings or sign out.
|
||
|
||
|
||
|
||
### Need Help
|
||
|
||
At the top right, you’ll find a <UiIcon lightIcon="https://i.imgur.com/CrABja9.png" darkIcon="https://i.imgur.com/cgeX2hP.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.
|
||
|
||
 |