From d24e159ebf9a57b3efcf54747312fe4f60ad7b44 Mon Sep 17 00:00:00 2001 From: L Suzuki <10970711+l-suzuki@users.noreply.github.com> Date: Wed, 28 Aug 2024 11:07:28 +1200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Matthew Borden --- pages/apis/graphql/cookbooks/rules.md | 1 - pages/apis/rest_api/rules.md | 2 +- pages/pipelines/rules/manage_rules.md | 4 ++-- pages/pipelines/rules/overview.md | 2 +- 4 files changed, 4 insertions(+), 5 deletions(-) diff --git a/pages/apis/graphql/cookbooks/rules.md b/pages/apis/graphql/cookbooks/rules.md index 954e397706..0eb5e3239b 100644 --- a/pages/apis/graphql/cookbooks/rules.md +++ b/pages/apis/graphql/cookbooks/rules.md @@ -37,7 +37,6 @@ Get the first 10 rules and their information for an organization: } } } - ``` ## Create a rule diff --git a/pages/apis/rest_api/rules.md b/pages/apis/rest_api/rules.md index 7053c8085c..e79b066908 100644 --- a/pages/apis/rest_api/rules.md +++ b/pages/apis/rest_api/rules.md @@ -6,7 +6,7 @@ The rules API lets you create and manage rules in your organization. [Rules](/docs/pipelines/rules/overview) allow you to manage permissions between Buildkite resources. -A rule is used to specify that an action is allowed between a source resource (e.g. a pipeline) and a target resource (e.g. another pipeline). Rules allow you to break out of the defaults provided by Buildkite such as cluster boundaries. +A rule is used to specify that an action is allowed between a source resource (e.g. a pipeline) and a target resource (e.g. another pipeline). Rules allow you to break out of the defaults provided by Buildkite such as the isolation between [clusters](/docs/clusters/overview). ### List rules diff --git a/pages/pipelines/rules/manage_rules.md b/pages/pipelines/rules/manage_rules.md index d2b9e355b9..cef798f4c2 100644 --- a/pages/pipelines/rules/manage_rules.md +++ b/pages/pipelines/rules/manage_rules.md @@ -40,7 +40,7 @@ where: <%= render_markdown partial: 'apis/descriptions/rest_pipeline_uuid' %> -## Using the GraphQL API +### Using the GraphQL API To [create a new rule](/docs/apis/graphql/schemas/mutation/rulecreate) using the [GraphQL API](/docs/apis/graphql-api), run the following example mutation: @@ -113,7 +113,7 @@ where: <%= render_markdown partial: 'apis/descriptions/rest_rule_uuid' %> -## Using the GraphQL API +### Using the GraphQL API To [delete a rule](/docs/apis/graphql/schemas/mutation/ruledelete) using the [GraphQL API](/docs/apis/graphql-api), run the following example mutation: diff --git a/pages/pipelines/rules/overview.md b/pages/pipelines/rules/overview.md index d79ec77e79..864cb30b6b 100644 --- a/pages/pipelines/rules/overview.md +++ b/pages/pipelines/rules/overview.md @@ -4,7 +4,7 @@ Rules allow you to manage permissions between Buildkite resources. Rules express that an action is allowed between a source resource (e.g. a pipeline) and a target resource (e.g. another pipeline). -Rules are typically used in tandem with [clusters](/docs/clusters/overview) to increase security and control, where clusters set hard boundaries and rules provide exceptions. +Rules provide explicit access between resources, allowing granting or restricting access between resources that would normally be determined by the default permissions. ## Available rule types