-
Notifications
You must be signed in to change notification settings - Fork 62k
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
base: main
Are you sure you want to change the base?
docs: fixes in Actions runner documentation #38685
Conversation
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. |
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 linksNote: Please update the URL for your staging server or codespace. The table shows the files in the Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
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. 😅 |
5bd9978
to
203bce1
Compare
thanks for the feedback, I felt the same and waited for your saying. I also felt the word |
@@ -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. |
There was a problem hiding this comment.
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.
203bce1
to
a24639e
Compare
a24639e
to
2643036
Compare
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: