Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

💬 Add section for team management topics #2483

Merged
merged 3 commits into from
Sep 20, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
1 change: 1 addition & 0 deletions config/routes.rb
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
get "/docs/pipelines/pipelines", to: redirect("/docs/pipelines")
get "/docs/pipelines/ignoring-a-commit", to: redirect("/docs/pipelines/skipping#ignore-a-commit")
get "/docs/pipelines/parallel-builds", to: redirect("/docs/tutorials/parallel-builds")
get "/docs/pipelines/permissions", to: redirect("/docs/team-management/permissions")
get "/docs/pipelines/plugins", to: redirect("/docs/plugins")
get "/docs/pipelines/uploading-pipelines", to: redirect("/docs/pipelines/defining-steps")
get "/docs/webhooks/setup", to: redirect("/docs/apis/webhooks")
Expand Down
8 changes: 6 additions & 2 deletions data/nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -304,12 +304,16 @@
path: "pipelines/security-overview"
- name: "Managing secrets"
path: "pipelines/secrets"
- name: "User and team permissions"
path: "pipelines/permissions"
- name: "Webhooks security"
path: "pipelines/incoming-webhooks"
- name: "Audit log"
path: "pipelines/audit-log"
- name: "Team management"
children:
- name: "Overview"
path: "team-management"
- name: "User and team permissions"
path: "team-management/permissions"
- name: "Governance"
children:
- name: "Overview"
Expand Down
2 changes: 1 addition & 1 deletion pages/apis/rest_api/agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Success response: `200 OK`
>📘 Required permissions
> To stop an agent you need either
- An Admin user API token with `write_agents` <a href="/docs/apis/managing-api-tokens#token-scopes">scope</a>
- Or, if you're using <a href="/docs/pipelines/permissions#member-permissions">Member Permissions</a>, a user token with the <em>Stop Agents</em> permission
- Or, if you're using <a href="/docs/team-management/permissions#member-permissions">Member Permissions</a>, a user token with the <em>Stop Agents</em> permission

Instruct an agent to stop accepting new build jobs and shut itself down.

Expand Down
2 changes: 1 addition & 1 deletion pages/clusters/manage_clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ To add a pipeline to a cluster:

### Add maintainers to a cluster

Only Buildkite administrators or users with the [_change organization_ permission](/docs/pipelines/permissions) can create clusters.
Only Buildkite administrators or users with the [_change organization_ permission](/docs/team-management/permissions) can create clusters.

You can assign other users or teams as a cluster’s maintainers to permit them to manage the cluster. Cluster maintainers can:

Expand Down
2 changes: 1 addition & 1 deletion pages/pipelines/trigger_step.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ All builds created by a trigger step will have the same author as the parent bui
* be a member of your organization
* have a verified email address

If you have [Teams](/docs/pipelines/permissions) enabled in your organization, *one* of the following conditions must be met:
If you have [Teams](/docs/team-management/permissions) enabled in your organization, *one* of the following conditions must be met:

* The authoring user must have 'Build' permission on *every* pipeline that will be triggered
* The triggering build has no creator and no unblocker, *and* the source pipeline and the target pipeline share a team that can 'Build'
Expand Down
10 changes: 10 additions & 0 deletions pages/team_management.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
toc: false
---

# Team management overview
olyism marked this conversation as resolved.
Show resolved Hide resolved

Team management is fundamental in CI/CD tools to ensure streamlined processes, proper access controls, and efficient collaboration. Buildkite provides features for your team management needs:
olyism marked this conversation as resolved.
Show resolved Hide resolved

- [User and team permissions](/docs/team-management/permissions)
- [Managing API access tokens](/docs/apis/managing-api-tokens) (under the APIs section)
File renamed without changes.
2 changes: 1 addition & 1 deletion pages/test_analytics/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Customers on the Buildkite [Business and Enterprise](https://buildkite.com/pricing) plans can manage permissions using [Teams](#permissions-with-teams). Enterprise customers can set fine-grained user permissions for their organization with the [Member Permissions](#member-permissions) page.

For more information on enabling Teams for your organization, please see the [Users and Teams section of Pipelines documentation](/docs/pipelines/permissions).
For more information on enabling Teams for your organization, please see the [Users and Teams section of Pipelines documentation](/docs/team-management/permissions).


## Permissions with teams
Expand Down