Skip to content

Commit 508b948

Browse files
authored
docs: update users user guide (#11531)
1 parent 77f37c5 commit 508b948

File tree

6 files changed

+95
-25
lines changed

6 files changed

+95
-25
lines changed

www/apps/user-guide/app/settings/page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export const metadata = {
1212

1313
Your Medusa store's settings are where you can manage your store's details, regions, sales channels, and more.
1414

15-
You can access your store's settings by clicking "Settings" item at the bottom of the sidebar. This shows a settings panel with a different sidebar to manage your store's data.
15+
You can access your store's settings by clicking the "Settings" item at the bottom of the sidebar. This shows a settings panel with a different sidebar to manage your store's data.
1616

1717
You can also go back to the main sidebar by clicking the <InlineIcon Icon={ArrowUturnLeft} alt="back" /> icon at the top of the sidebar.
1818

www/apps/user-guide/app/settings/users/invites/page.mdx

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,32 +10,30 @@ export const metadata = {
1010

1111
# {metadata.title}
1212

13-
In this document, you'll learn how to manage invites in your store.
13+
In this guide, you'll learn how to manage invites in your store.
1414

15-
## Overview
15+
## Add Admin Users through Invites
1616

17-
To add a new user to your team, you must invite them. The user gets a notification of the invite to sign up, but you can also send them the invite link to sign up.
17+
To add a new user to your team, you must invite them. The user gets a notification of the invite to sign up, but you can also manually send them the invite link to sign up.
1818

1919
<Note>
2020

2121
The form of notification sent (for example, an email) depends on what's configured in your store. If you're unsure about this, contact your technical team to configure it for you.
2222

2323
</Note>
2424

25+
---
26+
2527
## Invite a User
2628

2729
To send an invite to a user:
2830

2931
1. Go to Settings → Users.
3032
2. Click the Invite button.
31-
3. Enter the user’s email and choose their role.
33+
3. Enter the user’s email.
3234
4. Once done, click on the "Send invite" button.
3335

34-
<Note title="Info">
35-
36-
A user's role doesn't actually change the user's privileges. All users have the same admin privileges.
37-
38-
</Note>
36+
![Invite user form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739964961/User%20Guide/Screenshot_2025-02-19_at_1.35.52_PM_rewdrm.png)
3937

4038
---
4139

@@ -47,17 +45,23 @@ To view pending invites:
4745
2. Click the Invite button.
4846
3. Below the form, you'll find a Pending Invites table with all the invites that haven't been accepted yet.
4947

48+
![Pending invites table](https://res.cloudinary.com/dza7lstvk/image/upload/v1739964999/User%20Guide/Screenshot_2025-02-19_at_1.36.30_PM_jvkqcw.png)
49+
5050
---
5151

5252
## Resend an Invite
5353

54+
You can resend an invite if the user hasn't received it, they lost their link, or the invite has expired.
55+
5456
To resend an invite to a user:
5557

5658
1. Go to Settings → Users.
5759
2. Click the Invite button.
5860
3. In the Pending Invites table, find the user to resend their invite and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
5961
4. Choose "Resend invite" from the dropdown.
6062

63+
A notification will be sent to the user as configured by your technical team.
64+
6165
---
6266

6367
## Get Invite Link
@@ -71,14 +75,22 @@ To copy the invite link:
7175
3. In the Pending Invites table, find the user to resend their invite and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
7276
3. Choose “Copy invite link” from the dropdown.
7377

78+
You can then send this link to the user to sign up.
79+
7480
---
7581

76-
## Revoke Invite
82+
## Delete Invite
83+
84+
<Note type="warning">
85+
86+
Deleting an invite will revoke the invite and the user won't be able to sign up using that invite link.
87+
88+
</Note>
7789

78-
To revoke an invite:
90+
To delete an invite:
7991

8092
1. Go to Settings → Users.
8193
2. Click the Invite button.
8294
3. In the Pending Invites table, find the user to resend their invite and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
83-
4. Choose Revoke from the dropdown.
84-
5. Confirm revoking the invite by clicking the Revoke button in the pop-up.
95+
4. Choose Delete from the dropdown.
96+
5. Confirm deleting the invite by clicking the Delete button in the pop-up.

www/apps/user-guide/app/settings/users/page.mdx

Lines changed: 50 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,74 @@ sidebar_position: 3
33
sidebar_label: Users
44
---
55

6-
import { EllipsisHorizontal } from "@medusajs/icons"
6+
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
77

88
export const metadata = {
99
title: `Manage Users`,
1010
}
1111

1212
# {metadata.title}
1313

14-
In this document, you’ll learn how to invite new users, edit other users’ information, and remove users from your store.
14+
In this guide, you’ll learn how to manage users in your store.
15+
16+
<Note title="Tip">
17+
18+
You can't create a user. Instead, you need to [invite them](./invites/page.mdx) to join your store.
19+
20+
</Note>
1521

1622
## View Users
1723

18-
View admin users by going to Settings → Users.
24+
You can view admin users by going to Settings → Users. In the list, you can see user details such as the name and email. You can also search, filter, and sort the users to find the specific item you are looking for.
25+
26+
![Users List](https://res.cloudinary.com/dza7lstvk/image/upload/v1739964455/User%20Guide/Screenshot_2025-02-19_at_1.27.23_PM_qliac9.png)
1927

2028
---
2129

22-
## Edit a User’s Details
30+
## View User Details
2331

24-
To edit a user’s details in your team:
32+
To view the details of a user:
2533

2634
1. Go to Settings → Users.
27-
2. Find the user in the list and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
35+
2. Click on the user in the list.
36+
37+
This opens the user's details page where you can also manage the user.
38+
39+
![User details page](https://res.cloudinary.com/dza7lstvk/image/upload/v1739964575/User%20Guide/Screenshot_2025-02-19_at_1.29.20_PM_lffysp.png)
40+
41+
---
42+
43+
## Edit a User’s Details
44+
45+
To edit the details of an admin user:
46+
47+
1. Go to the user's details page.
48+
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
2849
3. Choose Edit from the dropdown.
29-
4. In the drawer that opens, edit the user’s information.
50+
4. In the side window that opens, you can edit the user's first and last names.
3051
5. Once done, click the Save button.
3152

53+
![Edit user details form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739964727/User%20Guide/Screenshot_2025-02-19_at_1.31.57_PM_nevurs.png)
54+
55+
---
56+
57+
## Manage User Metadata
58+
59+
Metadata is custom data that can be associated with the user in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the user.
60+
61+
To edit the user's metadata:
62+
63+
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of the "Metadata" section.
64+
2. In the side window that opens:
65+
- Manage the key-value pairs in the table.
66+
- To add a new row of key-value pairs before or after a row:
67+
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
68+
- Choose "Insert row above" or "Insert row below" from the dropdown.
69+
- To delete a row of key-value pairs:
70+
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
71+
- Choose "Delete row" from the dropdown.
72+
3. Once you're done, click the Save button.
73+
3274
---
3375

3476
## Delete a User
@@ -45,4 +87,4 @@ To delete a user from your store:
4587
2. Find the user in the list and click on it.
4688
3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
4789
4. Choose Delete from the dropdown.
48-
4. Confirm deleting the user by clicking the Delete button in the pop-up.
90+
4. Confirm deleting the user by entering their name and clicking the "Delete" button in the pop-up.

www/apps/user-guide/generated/edit-dates.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ export const generatedEditDates = {
33
"app/tips/bulk-editor/page.mdx": "2025-02-14T14:16:04.867Z",
44
"app/tips/lists/page.mdx": "2025-02-14T14:16:04.867Z",
55
"app/settings/sales-channels/page.mdx": "2024-05-03T17:36:38+03:00",
6-
"app/settings/users/page.mdx": "2024-05-03T17:36:38+03:00",
6+
"app/settings/users/page.mdx": "2025-02-19T11:34:00.736Z",
77
"app/settings/regions/manage/page.mdx": "2024-05-03T17:36:38+03:00",
88
"app/settings/taxes/tax-rates/page.mdx": "2024-05-03T17:36:38+03:00",
99
"app/page.mdx": "2025-02-14T11:18:46.636Z",
@@ -13,7 +13,7 @@ export const generatedEditDates = {
1313
"app/settings/regions/page.mdx": "2024-05-03T17:36:38+03:00",
1414
"app/settings/regions/shipping-options/page.mdx": "2024-05-03T17:36:38+03:00",
1515
"app/orders/page.mdx": "2025-02-17T15:13:42.484Z",
16-
"app/settings/users/invites/page.mdx": "2024-05-03T17:36:38+03:00",
16+
"app/settings/users/invites/page.mdx": "2025-02-19T11:38:54.009Z",
1717
"app/settings/taxes/page.mdx": "2024-05-03T17:36:38+03:00",
1818
"app/settings/developer/page.mdx": "2024-05-03T17:36:38+03:00",
1919
"app/settings/taxes/manage/page.mdx": "2024-05-03T17:36:38+03:00",

www/apps/user-guide/generated/sidebar.mjs

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,16 @@ export const generatedSidebar = [
371371
"type": "link",
372372
"title": "Users",
373373
"path": "/settings/users",
374-
"children": []
374+
"children": [
375+
{
376+
"loaded": true,
377+
"isPathHref": true,
378+
"type": "link",
379+
"title": "Invites",
380+
"path": "/settings/users/invites",
381+
"children": []
382+
}
383+
]
375384
},
376385
{
377386
"loaded": true,

www/apps/user-guide/sidebar.mjs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,13 @@ export const sidebar = sidebarAttachHrefCommonOptions([
228228
type: "link",
229229
title: "Users",
230230
path: "/settings/users",
231+
children: [
232+
{
233+
type: "link",
234+
title: "Invites",
235+
path: "/settings/users/invites",
236+
},
237+
],
231238
},
232239
{
233240
type: "link",

0 commit comments

Comments
 (0)