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

Update graphql_cookbook.md #2235

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

stephanieatte
Copy link
Contributor

Since cluster is newer features. No information about it in Graphql cookbook. I have added queries to create, update and delete a queue

Since cluster is newer features. No information about it in Graphql cookbook. I have added queries to create, update and delete a queue
@buildkite-docs-bot
Copy link
Collaborator

Preview URL: https://2235--bk-docs-preview.netlify.app

Copy link
Contributor

@mbelton-buildkite mbelton-buildkite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few style updates to apply to each new entry :)

Comment on lines +543 to +545
## Clusters

A collection of common tasks with clusters using the GraphQL API
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note, coordinate this with #2329. I think that one will merge first.


### Create a queue

Creates a new queue in a cluster
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Style: Make this a full sentence and use punctuation to link it to the example.

Suggested change
Creates a new queue in a cluster
Create a new queue in a cluster using the following call:

^ This applies to each entry.

Comment on lines +554 to +557
organizationId: "T3JnYW5pemF0aW9uLS0tZDZmNzU1NTEtZTM2OC00NzNmLTk1YzctNmFlOWU1OTNkOWU2",
clusterId: "Q2x1c3Rlci0tLWU3YWFjN2Q3LTg2ZmYtNDJjZi04NzYyLTM0ZjAwY2Q5MWRkOQ=="
key: "Default",
description: "The default queue"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make it clearer that these values need to be replaced:

Suggested change
organizationId: "T3JnYW5pemF0aW9uLS0tZDZmNzU1NTEtZTM2OC00NzNmLTk1YzctNmFlOWU1OTNkOWU2",
clusterId: "Q2x1c3Rlci0tLWU3YWFjN2Q3LTg2ZmYtNDJjZi04NzYyLTM0ZjAwY2Q5MWRkOQ=="
key: "Default",
description: "The default queue"
organizationId: "org-id",
clusterId: "cluster-id"
key: "queue-key",
description: "queue-description"

^ Applies to each entry.

deletedClusterQueueId
}
}
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Include a blank line between the codeblock and heading:

Suggested change
```
```

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants