Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 122 additions & 0 deletions docs/collaboration/inviting-team-members.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
---
title: "Inviting Team Members"
description: "Learn how to invite colleagues to your organisation, manage invitations, and control member roles"
---

Once logged into an organisation, administrators can invite team members via email and manage their roles and permissions.


## Sending an Invitation

<Steps>
<Step title="Navigate to Organization Settings">
Go to Settings → Organizations and select the organisation where you want to invite members.
</Step>

<Step title="Click Invite Member">
In the Members section, click the **Invite Member** button.

<Note>
The Invite Member button is only visible for organisations other than your personal organisation.
</Note>
</Step>

<Step title="Enter Email Address">
Provide the email address of the person you want to invite.

<Tip>
Ensure you use the correct email address, as the invitation will be sent there.
</Tip>
</Step>

<Step title="Select Member Role">
Choose the appropriate role for the new member:

- **Admin** - Can manage members, send invitations, and configure organisation settings
- **Member** - Can access shared projects and tasks (standard collaboration role)

<Warning>
Admins have full control over the organisation, including removing other members. Only grant admin access to trusted team members.
</Warning>
</Step>

<Step title="Send Invitation">
Click **Send Invitation** to dispatch the email invite.
</Step>
</Steps>

## Understanding Member Roles

### Member

Members can:
- Link their local projects to a remote project
- Share tasks with a project
- Create task attempts for tasks shared with them

### Admin

Administrators can do everything members can do, plus:
- Invite new members to the organisation
- Remove existing members
- Change member roles
- Manage pending invitations
- Delete the organisation (except personal organisations)

<Info>
Members cannot invite others or manage organisation settings. This keeps your team structure controlled.
</Info>

## Managing Pending Invitations

View all pending invitations in the **Pending Invitations** section of the Organization Settings page.

### Revoking an Invitation

If you need to revoke an invitation before it's accepted:

1. Locate the invitation in the Pending Invitations list
2. Click the **Revoke** button next to the invitation
3. The invitation link will be invalidated immediately

<Note>
Revoked invitations cannot be used, even if the recipient already received the email. You'll need to send a new invitation.
</Note>

## Managing Existing Members

### Viewing Members

The Members section displays all current organisation members with:
- Name and email
- Current role (Admin or Member)
- Membership status

### Changing Member Roles

To update a member's role:

1. Find the member in the Members list
2. Click the role dropdown next to their name
3. Select the new role (Admin or Member)
4. The change takes effect immediately

<Tip>
You can promote a member to admin or demote an admin to member at any time.
</Tip>

### Removing Members

To remove someone from the organisation:

1. Locate the member in the Members list
2. Click the **Remove** button
3. Confirm the removal when prompted

<Warning>
Removing a member is permanent. They will lose access to all shared organisation resources. You'll need to send a new invitation if you want them to rejoin.
</Warning>

## Accepting Invitations

When you invite someone, they'll receive an email with an invitation link. They just need to click it, log in with Google or GitHub, and accept the invitation to become a member of the organisation.
40 changes: 40 additions & 0 deletions docs/collaboration/logging-into-organizations.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: "Logging Into Organizations"
description: "Learn how to log in to access organization features and enable team collaboration"
---

Logging into an organisation enables team collaboration by making tasks visible to team members and controlling task assignment. While you can use Vibe Kanban locally without an account, logging in unlocks access to your personal organisation, the ability to create and join team organisations, and team member invitations and management.

## How to Log In

<Steps>
<Step title="Navigate to Organization Settings">
Open the Settings page by clicking the ⚙️ icon in the sidebar, then select **Organizations** from the settings menu.
</Step>

<Step title="Click the Login Button">
You'll see a login prompt with options to sign in via Google or GitHub OAuth.

<Frame>
<img src="/images/organization-login-button.png" alt="Organization settings page showing login button with Google and GitHub OAuth options" />
</Frame>
</Step>

<Step title="Choose Your Provider">
Select either:
- **Google** - Sign in with your Google account
- **GitHub** - Sign in with your GitHub account
</Step>

<Step title="Authorise Access">
Follow the OAuth flow to authorise Vibe Kanban to access your basic profile information.
</Step>
</Steps>

## After Logging In

Once authenticated, you'll automatically be logged into your **personal organisation**. This is a default organisation created specifically for you on first login, named after you. It functions like any other organisation, but you cannot leave or delete it.

<Card title="Inviting Team Members" icon="user-plus" href="/collaboration/inviting-team-members">
Learn how to invite colleagues to your organisation
</Card>
18 changes: 8 additions & 10 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,13 @@
"configuration-customisation/keyboard-shortcuts"
]
},
{
"group": "Team Collaboration",
"pages": [
"collaboration/logging-into-organizations",
"collaboration/inviting-team-members"
]
},
{
"group": "Integrations",
"pages": [
Expand Down Expand Up @@ -101,16 +108,7 @@
}
},
"contextual": {
"options": [
"copy",
"view",
"chatgpt",
"claude",
"perplexity",
"mcp",
"cursor",
"vscode"
]
"options": ["copy", "view", "chatgpt", "claude", "mcp"]
},
"integrations": {
"posthog": {
Expand Down
Binary file added docs/images/organization-login-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.