101 lines
4.9 KiB
Plaintext
101 lines
4.9 KiB
Plaintext
import { BellAlert, SidebarLeft } from "@medusajs/icons"
|
||
|
||
export const metadata = {
|
||
title: `Medusa Admin User Guide`,
|
||
}
|
||
|
||
# {metadata.title}
|
||
|
||
Welcome to the Medusa Admin user guide. This user guide is intended to help admin users learn how they can use the Medusa Admin to perform commerce operations and manage their store.
|
||
|
||
{/* TODO update photo */}
|
||
|
||
|
||
|
||
## Who is this guide for?
|
||
|
||
This guide is for Medusa Admin users looking to master the Medusa Admin and manage their store effectively. You don't need any technical knowledge to follow these guides.
|
||
|
||
You can also follow this guide if you're exploring Medusa and its operational features.
|
||
|
||
<Note>
|
||
|
||
For technical users, learn how to build and customize Medusa in [this documentation](!docs!/learn).
|
||
|
||
</Note>
|
||
|
||
## Access the Medusa Admin
|
||
|
||
To access the admin panel of your ecommerce store, open the URL of your local or deployed website. 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 team that deployed your Medusa application.
|
||
|
||
<Note title="Technical Tip">
|
||
|
||
Refer to [this documentation](!resources!/medusa-cli#user) on how to create a user.
|
||
|
||
</Note>
|
||
|
||
## Tour of Medusa Admin
|
||
|
||
After you log into your Medusa Admin, you see a sidebar menu to the left with a search bar at its top, a <InlineIcon Icon={BellAlert} alt="bell" /> 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 hide the sidebar by clicking the <InlineIcon Icon={SidebarLeft} alt="sidebar" /> icon at the top next to the sidebar. Clicking it again shows the sidebar.
|
||
|
||
### Sidebar Shortcuts
|
||
|
||
Sidebar items have shortcuts. For example, the Products page has a <Kbd>G</Kbd> then <Kbd>P</Kbd> shortcut. To view the shortcut of an item, hover your mouse for a few seconds and a tooltip will appear with the shortcut.
|
||
|
||
|
||
|
||
You can also find all shortcuts by clicking on your profile item at the bottom of the sidebar and choosing "Shortcuts".
|
||
|
||
### Settings and Quick Actions
|
||
|
||
At the bottom of the sidebar you'll find a Settings item, which takes you to further settings of your store such as Region and Sales Channel management. You'll also find your avatar and name.
|
||
|
||
|
||
|
||
By clicking on your avatar and name, you'll view quick actions such as going to profile settings, view shortcuts, or changing the admin theme.
|
||
|
||
|
||
|
||
### Search Bar
|
||
|
||
At the top of the sidebar, you'll find a search item. You can also 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, or use the up and down arrows on your keyboard to navigate between the results, then choose a result by hitting the <Kbd>Enter</Kbd> key.
|
||
|
||
### Check Notifications
|
||
|
||
At the top right you’ll find a <InlineIcon Icon={BellAlert} alt="Bell" /> icon. Clicking this icon opens a side window to view any notifications you might have. Use this to view notifications such as completed product exports.
|
||
|
||
|
||
|
||
### Change Language
|
||
|
||
The Medusa Admin supports multiple-languages, with English being the default one. Check out available languages [here](./tips/languages/page.mdx).
|
||
|
||
Learn how to change the language in [this guide](./settings/profile/page.mdx#change-admin-language).
|
||
|
||
### Change Admin Theme
|
||
|
||
The Medusa Admin comes in light and dark themes. You can change the theme by clicking the profile item at the bottom of the sidebar -> Theme -> Light, Dark, or System, defaulting to your Operating System or Browser theme.
|
||
|
||
{/* TODO add dark theme */}
|
||
|
||
|