From 95d16e9e73c082b3fa1398a988442cc97a3b7992 Mon Sep 17 00:00:00 2001 From: Chiggy-Playz Date: Fri, 2 Jan 2026 14:36:58 +0530 Subject: [PATCH 1/2] Add teams docs --- docs/teams.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ sidebars.js | 7 ++++++- 2 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 docs/teams.md diff --git a/docs/teams.md b/docs/teams.md new file mode 100644 index 0000000..582438d --- /dev/null +++ b/docs/teams.md @@ -0,0 +1,46 @@ +# Teams + +Cirun supports teams so multiple users can view and manage runner resources and permissions together. +A team in Cirun is linked to a single GitHub organization. When you create a team you connect it to a GitHub organization and give the team a custom name. Team membership is restricted to users who: + +- belong to the linked GitHub organization, and +- have an existing Cirun account. +There is no external invitation workflow: if a user is a member of the linked GitHub organization and already has a Cirun account, they can be added directly to the team. + +## Roles +Teams use three roles to control who can view and manage resources: + +- **Owner**: Full control over the team. Owners can manage members, repositories, and team settings. +- **Admin**: Can manage repositories assigned to the team (add/remove repositories) and perform other administrative tasks for the team. +- **Viewer**: Read-only. Can view runners, events, and analytics for repositories assigned to the team. + +When a user is added to a team they receive the **Viewer** role by default. Roles can be changed by team Owners. +A single user may be a member of multiple teams. + +## Creating a Team +To create a team you must provide: + +- the GitHub organization name to link the team to, and +- a custom team display name used inside Cirun. +Only administrators of the specified GitHub organization may create teams for that organization. + +## Access Granted by Team Membership +Members of a team gain access to the following for repositories that belong to the linked GitHub organization (and are assigned to the team): + +- list and view runners, +- view runner events and +- access analytics and usage data for the assigned runners. + +Membership grants access only to resources for repositories of the linked GitHub organization that are explicitly assigned to the team (see "Managing repositories" below). +## Managing Repositories (Admin role) + +Users with the **Admin** role on a team can add or remove repositories that the team has access to. To manage repositories: +1. Open the **Repositories** tab in the Cirun UI. +2. Use the team selector in the top-right to choose the target team. +3. Add or remove repositories for that team using the available controls. +When a repository is added to a team, team members immediately gain visibility into the repository's runners, events, and analytics according to their role. + +## Managing Members and Roles +- To add members: go to the Teams page, select the team, and add users by their GitHub username. Users are added only if they belong to the linked GitHub organization and have a Cirun account. +- To change a member's role: a team Owner can edit the member's role and choose between **Admin**, and **Viewer**. +- To remove a member: Only a team Owner can remove the user from the team. diff --git a/sidebars.js b/sidebars.js index 50de69a..c1d609e 100644 --- a/sidebars.js +++ b/sidebars.js @@ -59,13 +59,18 @@ module.exports = { type: "category", label: "Caching", link: { type: "doc", id: "caching/index" }, - items: ["caching/aws"] + items: ["caching/aws"], }, { type: "doc", label: "On-Prem", id: "on-prem", }, + { + type: "doc", + label: "Teams", + id: "teams", + }, { type: "category", label: "Custom Images", From 7eaaf88265b459a868cdf2cdbfc151acbe68bcaf Mon Sep 17 00:00:00 2001 From: Chiggy-Playz Date: Fri, 2 Jan 2026 14:37:05 +0530 Subject: [PATCH 2/2] Formatting --- docs/teams.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/teams.md b/docs/teams.md index 582438d..becd9e7 100644 --- a/docs/teams.md +++ b/docs/teams.md @@ -5,9 +5,10 @@ A team in Cirun is linked to a single GitHub organization. When you create a tea - belong to the linked GitHub organization, and - have an existing Cirun account. -There is no external invitation workflow: if a user is a member of the linked GitHub organization and already has a Cirun account, they can be added directly to the team. + There is no external invitation workflow: if a user is a member of the linked GitHub organization and already has a Cirun account, they can be added directly to the team. ## Roles + Teams use three roles to control who can view and manage resources: - **Owner**: Full control over the team. Owners can manage members, repositories, and team settings. @@ -18,13 +19,15 @@ When a user is added to a team they receive the **Viewer** role by default. Role A single user may be a member of multiple teams. ## Creating a Team + To create a team you must provide: - the GitHub organization name to link the team to, and - a custom team display name used inside Cirun. -Only administrators of the specified GitHub organization may create teams for that organization. + Only administrators of the specified GitHub organization may create teams for that organization. ## Access Granted by Team Membership + Members of a team gain access to the following for repositories that belong to the linked GitHub organization (and are assigned to the team): - list and view runners, @@ -32,15 +35,18 @@ Members of a team gain access to the following for repositories that belong to t - access analytics and usage data for the assigned runners. Membership grants access only to resources for repositories of the linked GitHub organization that are explicitly assigned to the team (see "Managing repositories" below). + ## Managing Repositories (Admin role) Users with the **Admin** role on a team can add or remove repositories that the team has access to. To manage repositories: + 1. Open the **Repositories** tab in the Cirun UI. 2. Use the team selector in the top-right to choose the target team. 3. Add or remove repositories for that team using the available controls. -When a repository is added to a team, team members immediately gain visibility into the repository's runners, events, and analytics according to their role. + When a repository is added to a team, team members immediately gain visibility into the repository's runners, events, and analytics according to their role. ## Managing Members and Roles + - To add members: go to the Teams page, select the team, and add users by their GitHub username. Users are added only if they belong to the linked GitHub organization and have a Cirun account. - To change a member's role: a team Owner can edit the member's role and choose between **Admin**, and **Viewer**. - To remove a member: Only a team Owner can remove the user from the team.