Skip to content

Commit

Permalink
Added user guide for teaming (#226)
Browse files Browse the repository at this point in the history
Signed-off-by: Vansh Bhatia <[email protected]>
  • Loading branch information
vanshBhatia-A4k9 authored Sep 27, 2023
1 parent 25dd7f5 commit 00a2336
Show file tree
Hide file tree
Showing 12 changed files with 17 additions and 21 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ sidebar_label: Accept invite

---

Once the invitation is received, you can take a look at details including the sender's name, role, and project name, then decide whether to accept or decline the invitation.
Once the invitation is received, you can take a look at invitation project name, and decide whether to accept or decline the invitation on the settings page.

<img src={require('../assets/user-guides/teaming/accept-invite/step-1.png').default} width="1000" height="500" />
<img src={require('../assets/user-guides/teaming/accept-invite/step-1.png').default} />

Once accepted, you can switch to the project using the header or the `View Project` option as shown below:
Once accepted, you can switch to the project using the side nav as shown below:

<img src={require('../assets/user-guides/teaming/accept-invite/step-2.png').default} width="1000" height="500" />
<img src={require('../assets/user-guides/teaming/accept-invite/step-2.png').default} />
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ sidebar_label: Edit/Cancel invite

If you had a change of mind and you wanted to change the role of an invitation that has been already sent, we got you!

Just go to the invited tab, change the role, and hit the `Resend` button. You can also cancel the invitation by just clicking on the `bin` icon.
Just go to the invited tab, change the role, and hit the `Resend` button. You can also cancel the invitation by just clicking on the `Remove` button.

<img src={require('../assets/user-guides/teaming/edit-invite/step-1.png').default} width="1000" height="500" />
<img src={require('../assets/user-guides/teaming/edit-invite/step-1.png').default} />

## Learn more

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,23 @@ sidebar_label: Invite Team Member

---

> In the `/settings` route (settings on the sidebar) the `Team` tab can be used to access the teaming feature by the `owner`. We recommend learning about the concept of [teaming](../concepts/teaming.md) before proceeding with the following user guides.
> In the `/setup` route (Project Setup > Members on the sidebar) the `Active/Pending members` tabs can be used to access the teaming feature by the `owner`. We recommend learning about the concept of [teaming](../concepts/teaming.md) before proceeding with the following user guides.
With this feature, you can select as many users you want, choose their roles individually and send the invitation at once! Once it is done successfully you can see the status of the sent invitation (whether it is in a pending/accepted/declined or exited state) along with all the other necessary details in the `Invited` tab.
With this feature, you can select as many users you want, choose their roles individually and send the invitation at once! Once it is done successfully you can see the status of the sent invitation (whether it is in a pending/accepted/declined or exited state) along with all the other necessary details in the `Pending members` tab.

## 1. Find the user you want to invite

In the team tab, click the `Invite new member` button as shown below:
In the team tab, click the `New member` button as shown below:

<img src={require('../assets/user-guides/teaming/invite-team-member/step-1.png').default} width="1000" height="500" />
<img src={require('../assets/user-guides/teaming/invite-team-member/step-1.png').default} />

## 2. Select all the members to be invited

From the list of all available members, choose the ones you want to collaborate on your chaos with and decide what project level access they should have to your project (Viewer/Editor) and hit the `Send Invite` button.
From the list of all available members, choose the ones you want to collaborate on your chaos with and decide what project level access they should have to your project (Viewer/Editor) and hit the same button.

<img src={require('../assets/user-guides/teaming/invite-team-member/step-2.png').default} width="1000" height="500" />
<img src={require('../assets/user-guides/teaming/invite-team-member/step-2.png').default} />

## 3. Collaborate over the chaos!

On successful invitation you will receive the confirmation dialog as shown below indicating selected members have been invited to your project.

<img src={require('../assets/user-guides/teaming/invite-team-member/step-3.png').default} width="1000" height="500" />
On successful acceptance of the invitation you will be able to collaborate over your project!

## Learn more

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ If you are the project owner, you have the ability to remove any members from yo

### 1. Identify the member to remove

In the `Team` tab in the settings page, scroll down to the `My project` table, here you will be able to see all the members who have their invitation status as `accepted` for your project collaboration invite. Here, identify the user to remove and click on the red `Remove` bin icon as shown.
In the `Active members` tab in the Members page, you will be able to see all the members who have their invitation status as `accepted` for your project collaboration invite. Here, identify the user to remove and click on the `Options` icon as shown and select the `Remove Member` option.

<img src={require('../assets/user-guides/teaming/remove-team-member/step-1.png').default} width="1000" height="500" />
<img src={require('../assets/user-guides/teaming/remove-team-member/step-1.png').default} />

### 2. Confirmation for removal

On hitting the `Remove` icon, you will be prompted to confirm the removal of the member, hit `Yes` to confirm and remove the member from your project.
On hitting the `Remove Member` option, you will be prompted to confirm the removal of the member, hit `Confirm` to confirm and remove the member from your project.

<img src={require('../assets/user-guides/teaming/remove-team-member/step-2.png').default} width="1000" height="500" />
<img src={require('../assets/user-guides/teaming/remove-team-member/step-2.png').default} />

0 comments on commit 00a2336

Please sign in to comment.