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 "Cluster" to the glossary #2222

Merged
merged 3 commits into from
Apr 4, 2024
Merged

Conversation

mbelton-buildkite
Copy link
Contributor

With clusters becoming generally available in the upcoming release and being an important concept to understand, I think it should have an entry in the glossary. I've taken a first pass from the info on the existing page, but very open to changing it.

@github-actions github-actions bot added the pipelines Pull requests that update content related to Pipelines label Jun 19, 2023
@buildkite-docs-bot
Copy link
Contributor

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

Copy link
Member

@timriley timriley left a comment

Choose a reason for hiding this comment

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

This is a good addition!

If I were to suggest one thing, it would be to emphasise that clusters contain queues of agents, since that's the main concept that people end up interacting with when they use clusters. I know you include queues in the latter part of the description, but that feels a bit like it's "burying the lede" IMHO :)

You might have a better idea about how to incorporate this into a short description, but I've provided one suggestion in case it helps :)

Otherwise, I'd still be very happy to see this added as-is. We can finesse it later.

pages/pipelines/glossary.md Outdated Show resolved Hide resolved
@gilesgas
Copy link
Contributor

gilesgas commented Apr 4, 2024

Thanks @timriley for reminding me of this PR! 🤦

I was meant to merge it a while back. I'll do so once its build completes successfully

@gilesgas gilesgas enabled auto-merge April 4, 2024 22:19
@gilesgas gilesgas merged commit 80826fe into main Apr 4, 2024
3 checks passed
@gilesgas gilesgas deleted the mbelton-add-cluster-to-glossary branch April 4, 2024 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pipelines Pull requests that update content related to Pipelines
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants