Skip to content

docs: fixes in Actions runner documentation #38685

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

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

Conversation

Rahul-Lashkari
Copy link
Contributor

Why:

Fixes in the GitHub Actions documentation related to self-hosted runners and the Actions Runner Controller (ARC).

Closes:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

Copy link

welcome bot commented Jun 2, 2025

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

Copy link
Contributor

github-actions bot commented Jun 2, 2025

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14 3.13
actions/hosting-your-own-runners/managing-self-hosted-runners/customizing-the-containers-used-by-jobs.md fpt
ghec
fpt
ghec

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jun 2, 2025
@Sharra-writes
Copy link
Contributor

Thanks for opening a PR! The use of binary vs. binaries seems really inconsistent to me in the original. "Binaries" is used once more in that same paragraph and once in the following paragraph, but then on line 106 it switches to "binary." 😵‍💫 I'm going to check in with the rest of the team about that, but if you can make it make sense, I would welcome the explanation from any source. 😅

@Sharra-writes Sharra-writes added content This issue or pull request belongs to the Docs Content team github_actions Pull requests that update GitHub Actions code and removed triage Do not begin working on this issue until triaged by the team labels Jun 2, 2025
@Rahul-Lashkari Rahul-Lashkari force-pushed the fix-docs-actions-runner-typos branch from 5bd9978 to 203bce1 Compare June 3, 2025 09:01
@Rahul-Lashkari
Copy link
Contributor Author

Thanks for opening a PR! The use of binary vs. binaries seems really inconsistent to me in the original. "Binaries" is used once more in that same paragraph and once in the following paragraph, but then on line 106 it switches to "binary." 😵‍💫 I'm going to check in with the rest of the team about that, but if you can make it make sense, I would welcome the explanation from any source. 😅

thanks for the feedback, I felt the same and waited for your saying. I also felt the word scale set would be much appropriate. I've updated the pr, hope this makes it! PTAL.

@@ -18,21 +18,21 @@ topics:

{% data reusables.actions.actions-runner-controller-about-arc %}

The following diagram illustrates the architecture of ARC's autoscaling runner scaleset mode.
The following diagram illustrates the architecture of ARC's autoscaling runner scale set mode.
Copy link
Contributor

Choose a reason for hiding this comment

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

Okay, this is also complicated. I think "ScaleSet" is correct, even though it's written as "Scale Sets" in one place, because I see names like "AutoScalingRunnerSet" and "RunnerSet" that follow the same format. The "scaleset" is more ambiguous, though, because "scale set" is used in the reusable on line 19. Lowercase "scaleset" might be the name of the mode, but it's not used that way consistently.

Here's what I would recommend: "ScaleSet" should always be one word, because it matches the other capitalized terms. Lowercase "scaleset" should always actually be "scale set." That should (🤞) make it consistent and more readable.

@Rahul-Lashkari Rahul-Lashkari force-pushed the fix-docs-actions-runner-typos branch from 203bce1 to a24639e Compare June 4, 2025 09:11
@Rahul-Lashkari Rahul-Lashkari force-pushed the fix-docs-actions-runner-typos branch from a24639e to 2643036 Compare June 4, 2025 09:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team github_actions Pull requests that update GitHub Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants