Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Matthew Borden <[email protected]>
  • Loading branch information
l-suzuki and matthewborden authored Aug 27, 2024
1 parent 77176f9 commit d24e159
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 5 deletions.
1 change: 0 additions & 1 deletion pages/apis/graphql/cookbooks/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ Get the first 10 rules and their information for an organization:
}
}
}
```

## Create a rule

Expand Down
2 changes: 1 addition & 1 deletion pages/apis/rest_api/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions pages/pipelines/rules/manage_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion pages/pipelines/rules/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit d24e159

Please sign in to comment.