Skip to content

Commit a950026

Browse files
Merge pull request #1800 from strapi/cloud/collaborate
Strapi Cloud: Collaboration & Shared projects
2 parents 4e3415c + a908606 commit a950026

File tree

6 files changed

+84
-0
lines changed

6 files changed

+84
-0
lines changed
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
title: Collaboration
3+
displayed_sidebar: cloudSidebar
4+
description: Share your projects on Strapi Cloud to collaborate with others.
5+
canonicalUrl: https://docs.strapi.io/cloud/projects/collaboration.md
6+
sidebar_position: 1
7+
---
8+
9+
# Collaboration on projects
10+
11+
Projects are created by a user via their Strapi Cloud account, which is linked to their GitHub account. Strapi Cloud users can share their projects to anyone else, so these new users can have access to the Cloud dashboard and collaborate on that project, without the project owner to ever have to share their GitHub credentials.
12+
13+
Users invited to collaborate on a project, called maintainers, do not have the same permissions as the project owner. Contrary to the project owner, maintainers:
14+
15+
- Cannot share the project themselves to someone else
16+
- Cannot delete the project from the project settings
17+
- Cannot access the *Billing* section of project settings
18+
19+
## Sharing a project
20+
21+
<ThemedImage
22+
alt="Share button and avatar"
23+
sources={{
24+
light: '/img/assets/cloud/collaboration-projectview.png',
25+
dark: '/img/assets/cloud/collaboration-projectview_DARK.png',
26+
}}
27+
/>
28+
29+
To invite a new maintainer to collaborate on a project:
30+
31+
1. Go to the *Overview* tab of your project dashboard.
32+
2. Click on the **Share** button in the top right hand corner.
33+
3. In the *Share [project name]* dialog, type the email address of the person to invite in the textbox. A dropdown indicating "Invite [email address]" should appear.
34+
4. Click on the dropdown: the email address should be displayed in a purple box right below the textbox.
35+
5. (optional) Repeat steps 3 and 4 to invite more people. Email addresses can only entered one by one but invites can be sent to several email addresses at the same time.
36+
6. Click on the **Send** button.
37+
38+
New maintainers will be sent an email containing a link to click on to join the project. Once a project is shared, avatars representing the maintainers will be displayed in the project dashboard next to the **Share** button, to see how many maintainers collaborate on that project and who they are.
39+
40+
:::tip
41+
Avatars use GitHub profile pictures, but for pending users only initials will be displayed until the activation of the maintainer account. You can hover over an avatar to display the full name of the maintainer.
42+
:::
43+
44+
## Managing maintainers
45+
46+
From the *Share [project name]* dialog accessible by clicking on the **Share** button of a project dashboard, projects owners can view the full list of maintainers who have been invited to collaborate on the project. From there, it is possible to see the current status of each maintainer and to manage them.
47+
48+
<ThemedImage
49+
alt="Share button and avatar"
50+
sources={{
51+
light: '/img/assets/cloud/collaboration-dialog.png',
52+
dark: '/img/assets/cloud/collaboration-dialog_DARK.png',
53+
}}
54+
/>
55+
56+
Maintainers whose full name is displayed are users who did activate their account following the invitation email. If however there are maintainers in the list whose email address is displayed, it means they haven't activated their accounts and can't access the project dashboard yet. In that case, a status should be indicated right next to the email address to explain the issue:
57+
58+
- Pending: the invitation email has been sent but the maintainer hasn't acted on it yet.
59+
- Expired: the email has been sent over 72 hours ago and the invitation expired.
60+
61+
For Expired statuses, it is possible to send another invitation email by clicking on the **Manage** button, then **Resend invite**.
62+
63+
### Revoking maintainers
64+
65+
To revoke a maintainer's access to the project dashboard:
66+
67+
1. Click on the **Share** button in the project dashboard.
68+
2. In the list of *People with access*, find the maintainer whose access to revoke and click on the **Manage** button.
69+
3. Click on the **Revoke** button.
70+
4. In the confirmation dialog, click again on the **Revoke** button.
71+
72+
The revoked maintainer will completely stop having access to the project dashboard.
73+
74+
:::note
75+
Maintainers whose access to the project has been revoked do not receive any email or notification.
76+
:::

docusaurus/sidebars.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -547,6 +547,14 @@ const sidebars = {
547547
updated: true,
548548
},
549549
},
550+
{
551+
type: 'doc',
552+
label: 'Collaboration',
553+
id: 'cloud/projects/collaboration',
554+
customProps: {
555+
new: true,
556+
},
557+
},
550558
{
551559
type: 'doc',
552560
label: 'Notifications',
328 KB
Loading
314 KB
Loading
243 KB
Loading
246 KB
Loading

0 commit comments

Comments
 (0)