bb87db8342
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
106 lines
4.0 KiB
Plaintext
106 lines
4.0 KiB
Plaintext
---
|
||
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.
|