From ab80023a954e438d615ab4829e4e96e23ab28275 Mon Sep 17 00:00:00 2001 From: Oly Su Date: Tue, 19 Sep 2023 15:58:30 +1000 Subject: [PATCH 1/3] =?UTF-8?q?=F0=9F=9A=9A=20Move=20permissions=20under?= =?UTF-8?q?=20a=20new=20team-management=20menu?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Move permissions.md and assets under /team_management - Created new team-management nav menu - Added Team Management overview page - Updated existing links - Add redirect from existing url --- config/routes.rb | 1 + data/nav.yml | 8 ++++++-- .../permissions/enable-teams.png | Bin .../permissions/remove-user.png | Bin pages/apis/rest_api/agents.md | 2 +- pages/clusters/manage_clusters.md | 2 +- pages/pipelines/trigger_step.md | 2 +- pages/team_management.md | 10 ++++++++++ pages/{pipelines => team_management}/permissions.md | 0 pages/test_analytics/permissions.md | 2 +- 10 files changed, 21 insertions(+), 6 deletions(-) rename images/docs/{pipelines => team_management}/permissions/enable-teams.png (100%) rename images/docs/{pipelines => team_management}/permissions/remove-user.png (100%) create mode 100644 pages/team_management.md rename pages/{pipelines => team_management}/permissions.md (100%) diff --git a/config/routes.rb b/config/routes.rb index 2a21cdebd6..60fd689947 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -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") diff --git a/data/nav.yml b/data/nav.yml index 439cbf6f78..b9a4037608 100644 --- a/data/nav.yml +++ b/data/nav.yml @@ -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" diff --git a/images/docs/pipelines/permissions/enable-teams.png b/images/docs/team_management/permissions/enable-teams.png similarity index 100% rename from images/docs/pipelines/permissions/enable-teams.png rename to images/docs/team_management/permissions/enable-teams.png diff --git a/images/docs/pipelines/permissions/remove-user.png b/images/docs/team_management/permissions/remove-user.png similarity index 100% rename from images/docs/pipelines/permissions/remove-user.png rename to images/docs/team_management/permissions/remove-user.png diff --git a/pages/apis/rest_api/agents.md b/pages/apis/rest_api/agents.md index 3bf0a8fbb1..e1e89bc94f 100644 --- a/pages/apis/rest_api/agents.md +++ b/pages/apis/rest_api/agents.md @@ -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` scope -- Or, if you're using Member Permissions, a user token with the Stop Agents permission +- Or, if you're using Member Permissions, a user token with the Stop Agents permission Instruct an agent to stop accepting new build jobs and shut itself down. diff --git a/pages/clusters/manage_clusters.md b/pages/clusters/manage_clusters.md index 22e9ac1e74..e5ee6aa745 100644 --- a/pages/clusters/manage_clusters.md +++ b/pages/clusters/manage_clusters.md @@ -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: diff --git a/pages/pipelines/trigger_step.md b/pages/pipelines/trigger_step.md index 147b51c67f..311c1b3d3c 100644 --- a/pages/pipelines/trigger_step.md +++ b/pages/pipelines/trigger_step.md @@ -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' diff --git a/pages/team_management.md b/pages/team_management.md new file mode 100644 index 0000000000..b05209cbbd --- /dev/null +++ b/pages/team_management.md @@ -0,0 +1,10 @@ +--- +toc: false +--- + +# Team management overview + +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: + +- [User and team permissions](/docs/team-management/permissions) +- [Managing API access tokens](/docs/apis/managing-api-tokens) (under the APIs section) diff --git a/pages/pipelines/permissions.md b/pages/team_management/permissions.md similarity index 100% rename from pages/pipelines/permissions.md rename to pages/team_management/permissions.md diff --git a/pages/test_analytics/permissions.md b/pages/test_analytics/permissions.md index 5e3df6cfec..7f7785baf0 100644 --- a/pages/test_analytics/permissions.md +++ b/pages/test_analytics/permissions.md @@ -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 From d6d185a5b9a918e28b89c8168c4a84ac4bd4eba0 Mon Sep 17 00:00:00 2001 From: Oly Su Date: Wed, 20 Sep 2023 09:56:05 +1000 Subject: [PATCH 2/3] =?UTF-8?q?=F0=9F=92=AC=20Team=20management=20heading?= =?UTF-8?q?=20tweak?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Accept commit suggestion Co-authored-by: Melissa Kaulfuss --- pages/team_management.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/team_management.md b/pages/team_management.md index b05209cbbd..ed250a6963 100644 --- a/pages/team_management.md +++ b/pages/team_management.md @@ -2,7 +2,7 @@ toc: false --- -# Team management overview +# Team management 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: From 1dacb00fc8a2c41b42debc0a0bdf701a4b8b4455 Mon Sep 17 00:00:00 2001 From: Oly Su Date: Wed, 20 Sep 2023 09:57:47 +1000 Subject: [PATCH 3/3] =?UTF-8?q?=F0=9F=92=AC=20Team=20management=20opening?= =?UTF-8?q?=20sentence=20improvement?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Accept commit suggestion Co-authored-by: Melissa Kaulfuss --- pages/team_management.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/team_management.md b/pages/team_management.md index ed250a6963..4126663c81 100644 --- a/pages/team_management.md +++ b/pages/team_management.md @@ -4,7 +4,7 @@ toc: false # Team management -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: +Managing users and teams in CI/CD is fundamental to collaboration, streamlined processes, and ensuring adequate access controls. Buildkite provides features to manage team access: - [User and team permissions](/docs/team-management/permissions) - [Managing API access tokens](/docs/apis/managing-api-tokens) (under the APIs section)