docs: create docs workspace (#5174)
* 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
This commit is contained in:
Shahed Nasser
GitHub
9
www/apps/docs/content/user-guide/users/_category_.json
Normal file
9
www/apps/docs/content/user-guide/users/_category_.json
Normal file
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"position": 12,
|
||||
"collapsed": false,
|
||||
"link": null,
|
||||
"label": "Users",
|
||||
"customProps": {
|
||||
"sidebar_is_group_headline": true
|
||||
}
|
||||
}
|
||||
21
www/apps/docs/content/user-guide/users/index.md
Normal file
21
www/apps/docs/content/user-guide/users/index.md
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: 'Medusa admin can be accessed more than one user. Merchants can have users added into their team to use the Medusa admin.'
|
||||
---
|
||||
|
||||
# Users Overview
|
||||
|
||||
In this document, you’ll get an overview of features related to users and teams.
|
||||
|
||||
## Overview
|
||||
|
||||
Only users who are part of the store’s team can access the Medusa admin. You can have more than one user in a team. Each user must have an email and password to log in.
|
||||
|
||||
As an admin, you can manage the users’ roles and information. You can also invite or remove users.
|
||||
|
||||
---
|
||||
|
||||
## Learn More About Users
|
||||
|
||||
- [Manage Profile](./profile.md)
|
||||
- [Manage Team](./team.mdx)
|
||||
64
www/apps/docs/content/user-guide/users/profile.md
Normal file
64
www/apps/docs/content/user-guide/users/profile.md
Normal file
@@ -0,0 +1,64 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: 'This user guide explains how to manage user profile on the Medusa admin. Learn how to edit a user profile and reset user password.'
|
||||
addHowToData: true
|
||||
---
|
||||
|
||||
# Manage Profile
|
||||
|
||||
In this document, you’ll learn how to manage your account including resetting your password and editing your account details.
|
||||
|
||||
## Reset Password
|
||||
|
||||
To reset your password:
|
||||
|
||||
1. On the login screen, click on the “Forget your password?” link.
|
||||
2. Enter the email of your account.
|
||||
3. Click on the “Send reset instructions” button.
|
||||
4. You’ll find the instructions to reset your password in the email you receive.
|
||||
|
||||
:::note
|
||||
|
||||
If you don’t receive an email, please get in touch with your technical team to ensure an email service is set up correctly.
|
||||
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Edit Profile
|
||||
|
||||
To edit your profile details:
|
||||
|
||||
1. Go to Settings → Personal Information.
|
||||
2. Click on the “Edit information” button.
|
||||
3. In the form that opens, you can edit your personal information.
|
||||
4. Once done, click on the “Submit and close” button.
|
||||
|
||||
---
|
||||
|
||||
## Change Admin Language
|
||||
|
||||
The Medusa admin supports multiple languages, and you can change the default language from your profile settings.
|
||||
|
||||
To change the language:
|
||||
|
||||
1. Go to Settings → Personal Information.
|
||||
2. For the Language field, select the language you want from the dropdown.
|
||||
3. The language will be saved and changed.
|
||||
|
||||
:::tip
|
||||
|
||||
Can't find your language? Learn how you can contribute by translating the admin to other languages [here](../../contribution/admin-translations.md).
|
||||
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Edit Analytics Preferences
|
||||
|
||||
To edit your analytics collection preferences:
|
||||
|
||||
1. Go to Settings → Personal Information.
|
||||
2. Click on the “Edit preferences” button.
|
||||
3. In the form that opens, you can edit any of the options.
|
||||
4. Once done, click on the “Submit and close” button.
|
||||
105
www/apps/docs/content/user-guide/users/team.mdx
Normal file
105
www/apps/docs/content/user-guide/users/team.mdx
Normal file
@@ -0,0 +1,105 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: 'This user guide explains how to manage the team on the Medusa admin. Learn how to invite users to your team and edit their details.'
|
||||
addHowToData: true
|
||||
---
|
||||
|
||||
import UiIcon from '@site/src/components/UiIcon';
|
||||
|
||||
# Manage Team
|
||||
|
||||
In this document, you’ll learn how to invite new users, edit other users’ information, and remove users from your team.
|
||||
|
||||
## View your Team
|
||||
|
||||
You can view your team by going to Settings → The Team.
|
||||
|
||||
---
|
||||
|
||||
## Manage Invites
|
||||
|
||||
To add a new user to your team, you must invite them. Invites are sent by email, but you can also copy the invite link and send it personally to the user.
|
||||
|
||||
:::note
|
||||
|
||||
By default, your store doesn't handle sending invites to the user through a notification, such as an email. Your developer team must setup and configure a Notification service that handles this functionality.
|
||||
|
||||
:::
|
||||
|
||||
### Invite a User
|
||||
|
||||
To send an invite to a user:
|
||||
|
||||
1. Go to your team page.
|
||||
2. Click on the Invite Users button.
|
||||
3. Enter the user’s email and choose their role.
|
||||
4. Once done, click on the Invite button.
|
||||
|
||||
:::tip
|
||||
|
||||
A user's role doesn't actually change the user's privileges. All users have the same admin privileges.
|
||||
|
||||
:::
|
||||
|
||||
### Resend an Invite
|
||||
|
||||
If you want the user to receive a new email with the invite link, you can resend an invite to them.
|
||||
|
||||
To resend an invite to a user:
|
||||
|
||||
1. Go to your team page.
|
||||
2. Find the user that you want to resend an invite to, then click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at its right.
|
||||
3. Click on Resend Invitation from the dropdown.
|
||||
|
||||
### Get Invite Link
|
||||
|
||||
In addition to sending the user an invite, you can copy the invite link and send it manually to the user.
|
||||
|
||||
To copy the invite link:
|
||||
|
||||
1. Go to your team page.
|
||||
2. Find the user invite, then click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at its right.
|
||||
3. Click on “Copy invite link” from the dropdown.
|
||||
|
||||
### Remove Invite
|
||||
|
||||
:::info
|
||||
|
||||
Removing an invite would prevent the invited user from joining the team, even if they have the invitation link.
|
||||
|
||||
:::
|
||||
|
||||
To remove an invite:
|
||||
|
||||
1. Go to your team page.
|
||||
2. Find the user invite, then click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at its right.
|
||||
3. Click on “Remove invitation” from the dropdown.
|
||||
4. Confirm removing the invitation by clicking the “Yes, remove” button in the pop-up.
|
||||
|
||||
---
|
||||
|
||||
## Edit a User’s Details
|
||||
|
||||
To edit a user’s details in your team:
|
||||
|
||||
1. Go to your team page.
|
||||
2. Find the user and click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at its right.
|
||||
3. In the new form, edit any of the user’s information.
|
||||
4. Once done, click on the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Remove a User
|
||||
|
||||
:::warning
|
||||
|
||||
Removing a user from a team can’t be done. The user’s details will be lost.
|
||||
|
||||
:::
|
||||
|
||||
To remove a user from your team:
|
||||
|
||||
1. Go to your team page.
|
||||
2. Find the user and click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at its right.
|
||||
3. Click on Remove User from the dropdown.
|
||||
4. Confirm removing the user by clicking the “Yes, remove” button in the pop-up.
|
||||
Reference in New Issue
Block a user