95 lines
4.0 KiB
Plaintext
95 lines
4.0 KiB
Plaintext
import { BellAlert, Sidebar } from "@medusajs/icons"
|
||
|
||
export const metadata = {
|
||
title: `Medusa Admin User Guide`,
|
||
}
|
||
|
||
# {metadata.title}
|
||
|
||
This user guide is intended to help users learn how they can use the Medusa Admin to perform different operational and ecommerce tasks.
|
||
|
||
{/* TODO change image */}
|
||
|
||
|
||
|
||
## 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 personnel that deployed your Medusa application and admin.
|
||
|
||
<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, 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.
|
||
|
||
{/* TODO update image */}
|
||
|
||
|
||
|
||
You can hide the sidebar by clicking the <InlineIcon Icon={Sidebar} alt="sidebar" /> icon at the top next to the sidebar. Clicking it again shows the sidebar.
|
||
|
||
### Search Bar
|
||
|
||
You’ll find at the top of the page a search bar. Use this search bar to search orders, products, customers, and more information available in your Medusa Admin.
|
||
|
||
<Note title="Tip">
|
||
|
||
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>
|
||
|
||
</Note>
|
||
|
||
{/* TODO check if image needs updating */}
|
||
|
||
|
||
|
||
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.
|
||
|
||
{/* TODO change images */}
|
||
|
||
|
||
|
||
### 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).
|
||
|
||
### Quick Actions
|
||
|
||
At the top right in the sidebar, you’ll find an avatar icon with your email or name. By clicking this icon, you’ll see a dropdown. Use this dropdown to access settings or sign out.
|
||
|
||
{/* TODO check if image needs updating */}
|
||
|
||
|
||
|
||
### Change Theme
|
||
|
||
The Medusa Admin supports both light and dark modes.
|
||
|
||
|
||
|
||
You can switch the theme by opening the quick actions dropdown, choosing theme, then choosing the prefered mode.
|
||
|
||
 |