914d773d3a
* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
74 lines
4.0 KiB
Plaintext
74 lines
4.0 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.
|
||
|
||
|
||
|
||
### 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.
|
||
|
||
 |