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

Doc 654 add reference to queues on branch configurations #2392

Merged

Conversation

clbarrell
Copy link
Contributor

Purpose of this was to add Agent Queues as an alternative way of filtering pipelines and steps from being done – and where (agents) they are completed.

Then I added another example to the Queues page so it was clear the queue YAML attribute could be used as either root level or on a specific step.

Then I added a reference to branch filtering from the Queues page for completeness.

QUERY: I wasn't sure about referencing things as either 'build steps' or 'jobs'. It differs page to page. Welcome your input @mbelton-buildkite

@github-actions github-actions bot added pipelines Pull requests that update content related to Pipelines agent labels Aug 21, 2023
@mbelton-buildkite
Copy link
Contributor

I'll need to sleep on this one. It's useful information that I think we should include, but it's not clear if this is the right way to go about it.

I believe the proper place to draw this connection is on an explanation page that talks about controlling when and where jobs run on agents. But I don't believe that page exists.

Without that, I see three ways to incorporate it on these pages:

  1. As a normal part of the intro content, like you have it. My concern with this is that it immediately suggests going to a different page before people get into the content of this page.
  2. A callout in the intro content. This would help separate it from the regular content, but my concern is that it'll highlight it too much.
  3. Add a new section at the end of the page, "Related concent/concepts." The drawback here is that you might miss it.

I'm leaning towards 3. What do you think?

@mbelton-buildkite
Copy link
Contributor

I see three ways to incorporate it on these pages:

  1. As a normal part of the intro content, like you have it. My concern with this is that it immediately suggests going to a different page before people get into the content of this page.
  2. A callout in the intro content. This would help separate it from the regular content, but my concern is that it'll highlight it too much.
  3. Add a new section at the end of the page, "Related concent/concepts." The drawback here is that you might miss it.

I think 3 is the way to go, with a new section "## Alternative methods" at the end of the page. I won't have time to look at it today, but can help tomorrow.

@clbarrell
Copy link
Contributor Author

Thanks Will do 👍

@clbarrell
Copy link
Contributor Author

can you re -review @mbelton-buildkite

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.

One more tweak and then I think it'll be good to go

pages/agent/v3/queues.md Outdated Show resolved Hide resolved
pages/pipelines/branch_configuration.md Outdated Show resolved Hide resolved
clbarrell and others added 2 commits August 24, 2023 17:16
Co-authored-by: Michael Belton <119824349+mbelton-buildkite@users.noreply.github.com>
Co-authored-by: Michael Belton <119824349+mbelton-buildkite@users.noreply.github.com>
@clbarrell clbarrell merged commit 4eaccc9 into main Aug 24, 2023
1 check passed
@clbarrell clbarrell deleted the doc-654-add-reference-to-queues-on-branch-configurations branch August 24, 2023 07:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
agent pipelines Pull requests that update content related to Pipelines
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants