Skip to content

Commit a325cc7

Browse files
salmanmkcsalmanmkc
authored
Small readme updates for readability (#3860)
1 parent d4e3d2a commit a325cc7

File tree

6 files changed

+43
-44
lines changed

6 files changed

+43
-44
lines changed

‎README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,22 @@ Actions Runner Controller (ARC) is a Kubernetes operator that orchestrates and s
1111
With ARC, you can create runner scale sets that automatically scale based on the number of workflows running in your repository, organization, or enterprise. Because controlled runners can be ephemeral and based on containers, new runner instances can scale up or down rapidly and cleanly. For more information about autoscaling, see ["Autoscaling with self-hosted runners."](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/autoscaling-with-self-hosted-runners)
1212

1313
You can set up ARC on Kubernetes using Helm, then create and run a workflow that uses runner scale sets. For more information about runner scale sets, see ["Deploying runner scale sets with Actions Runner Controller."](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller#runner-scale-set)
14+
1415
## People
1516

1617
Actions Runner Controller (ARC) is an open-source project currently developed and maintained in collaboration with the GitHub Actions team, external maintainers @mumoshu and @toast-gear, various [contributors](https://github.com/actions/actions-runner-controller/graphs/contributors), and the [awesome community](https://github.com/actions/actions-runner-controller/discussions).
1718

1819
If you think the project is awesome and is adding value to your business, please consider directly sponsoring [community maintainers](https://github.com/sponsors/actions-runner-controller) and individual contributors via GitHub Sponsors.
1920

20-
In case you are already the employer of one of contributors, sponsoring via GitHub Sponsors might not be an option. Just support them in other means!
21+
If you are already the employer of one of the contributors, sponsoring via GitHub Sponsors might not be an option. Just support them by other means!
2122

2223
See [the sponsorship dashboard](https://github.com/sponsors/actions-runner-controller) for the former and the current sponsors.
2324

2425
## Getting Started
2526

26-
To give ARC a try with just a handful of commands, Please refer to the [Quickstart guide](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller).
27+
To give ARC a try with just a handful of commands, please refer to the [Quickstart guide](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller).
2728

28-
For an overview of ARC, please refer to [About ARC](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller)
29+
For an overview of ARC, please refer to [About ARC](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller).
2930

3031
With the introduction of [autoscaling runner scale sets](https://github.com/actions/actions-runner-controller/discussions/2775), the existing [autoscaling modes](./docs/automatically-scaling-runners.md) are now legacy. The legacy modes have certain use cases and will continue to be maintained by the community only.
3132

@@ -37,7 +38,7 @@ ARC documentation is available on [docs.github.com](https://docs.github.com/en/a
3738

3839
### Legacy documentation
3940

40-
The following documentation is for the legacy autoscaling modes that continue to be maintained by the community
41+
The following documentation is for the legacy autoscaling modes that continue to be maintained by the community:
4142

4243
- [Quickstart guide](/docs/quickstart.md)
4344
- [About ARC](/docs/about-arc.md)

‎contrib/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The `contrib` directory is the place for sharing various example code for deploying and operating `actions-runner-controller`.
22

3-
Anything contained in this directory is provided as-is. The maintainers of `actions-runner-controller` is not yet commited to provide
4-
full support for using, fixing, and enhancing it. However, they will do their best effort to collect feedbacks from early adopters and advanced users like you, and may eventually consider graduating any of the examples as an official addition to the project.
3+
Anything contained in this directory is provided as-is. The maintainers of `actions-runner-controller` are not yet committed to provide
4+
full support for using, fixing, and enhancing it. However, they will make their best effort to collect feedback from early adopters and advanced users like you, and may eventually consider graduating any of the examples as an official addition to the project.
55

66
See https://github.com/actions/actions-runner-controller/pull/1375#issuecomment-1258816470 and https://github.com/actions/actions-runner-controller/pull/1559#issuecomment-1258827496 for more context.

‎contrib/examples/actions-runner/README.md

+26-26
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,29 @@ All additional docs are kept in the `docs/` folder, this README is solely for do
88

99
> _Default values are the defaults set in the charts values.yaml, some properties have default configurations in the code for when the property is omitted or invalid_
1010
11-
| Key | Description | Default |
12-
|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
13-
| `labels` | Set labels to apply to all resources in the chart | |
14-
| `replicaCount` | Set the number of runner pods | 1 |
15-
| `image.repository` | The "repository/image" of the runner container | summerwind/actions-runner |
16-
| `image.tag` | The tag of the runner container | |
17-
| `image.pullPolicy` | The pull policy of the runner image | IfNotPresent |
18-
| `imagePullSecrets` | Specifies the secret to be used when pulling the runner pod containers | |
19-
| `fullnameOverride` | Override the full resource names | |
20-
| `nameOverride` | Override the resource name prefix | |
21-
| `podAnnotations` | Set annotations for the runner pod | |
22-
| `podLabels` | Set labels for the runner pod | |
23-
| `podSecurityContext` | Set the security context to runner pod | |
24-
| `nodeSelector` | Set the pod nodeSelector | |
25-
| `affinity` | Set the runner pod affinity rules | |
26-
| `tolerations` | Set the runner pod tolerations | |
27-
| `env` | Set environment variables for the runner container | |
28-
| `organization` | Github organization where runner will be registered | test |
29-
| `repository` | Github repository where runner will be registered | |
30-
| `runnerLabels` | Labels you want to add in your runner | test |
31-
| `autoscaler.enabled` | Enable the HorizontalRunnerAutoscaler, if its enabled then replica count will not be used | true |
32-
| `autoscaler.minReplicas` | Minimum no of replicas | 1 |
33-
| `autoscaler.maxReplicas` | Maximum no of replicas | 5 |
34-
| `autoscaler.scaleDownDelaySecondsAfterScaleOut` | [Anti-Flapping Configuration](https://github.com/actions/actions-runner-controller/blob/master/docs/automatically-scaling-runners.md#anti-flapping-configuration) | 120 |
35-
| `autoscaler.metrics` | [Pull driven scaling](https://github.com/actions/actions-runner-controller/blob/master/docs/automatically-scaling-runners.md#pull-driven-scaling) | default |
36-
| `autoscaler.scaleUpTriggers` | [Webhook driven scaling](https://github.com/actions/actions-runner-controller/blob/master/docs/automatically-scaling-runners.md#webhook-driven-scaling) | |
11+
| Key | Description | Default |
12+
| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
13+
| `labels` | Set labels to apply to all resources in the chart | |
14+
| `replicaCount` | Set the number of runner pods | 1 |
15+
| `image.repository` | The "repository/image" of the runner container | summerwind/actions-runner |
16+
| `image.tag` | The tag of the runner container | |
17+
| `image.pullPolicy` | The pull policy of the runner image | IfNotPresent |
18+
| `imagePullSecrets` | Specifies the secret to be used when pulling the runner pod containers | |
19+
| `fullnameOverride` | Override the full resource names | |
20+
| `nameOverride` | Override the resource name prefix | |
21+
| `podAnnotations` | Set annotations for the runner pod | |
22+
| `podLabels` | Set labels for the runner pod | |
23+
| `podSecurityContext` | Set the security context to runner pod | |
24+
| `nodeSelector` | Set the pod nodeSelector | |
25+
| `affinity` | Set the runner pod affinity rules | |
26+
| `tolerations` | Set the runner pod tolerations | |
27+
| `env` | Set environment variables for the runner container | |
28+
| `organization` | Github organization where the runner will be registered | test |
29+
| `repository` | Github repository where the runner will be registered | |
30+
| `runnerLabels` | Labels you want to add in your runner | test |
31+
| `autoscaler.enabled` | Enable the HorizontalRunnerAutoscaler, if its enabled then replica count will not be used | true |
32+
| `autoscaler.minReplicas` | Minimum no of replicas | 1 |
33+
| `autoscaler.maxReplicas` | Maximum no of replicas | 5 |
34+
| `autoscaler.scaleDownDelaySecondsAfterScaleOut` | [Anti-Flapping Configuration](https://github.com/actions/actions-runner-controller/blob/master/docs/automatically-scaling-runners.md#anti-flapping-configuration) | 120 |
35+
| `autoscaler.metrics` | [Pull driven scaling](https://github.com/actions/actions-runner-controller/blob/master/docs/automatically-scaling-runners.md#pull-driven-scaling) | default |
36+
| `autoscaler.scaleUpTriggers` | [Webhook driven scaling](https://github.com/actions/actions-runner-controller/blob/master/docs/automatically-scaling-runners.md#webhook-driven-scaling) | |

‎docs/gha-runner-scale-set-controller/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ In addition to the increased reliability of the automatic scaling, we have worke
3131

3232
[![Watch the walkthrough](thumbnail.png)](https://youtu.be/wQ0k5k6KW5Y)
3333

34-
> Will take you to Youtube for a short walkthrough of the Autoscaling Runner Scale Sets mode.
34+
> Will take you to YouTube for a short walkthrough of the Autoscaling Runner Scale Sets mode.
3535
3636
## Setup
3737

@@ -201,7 +201,7 @@ Please evaluate these changes carefully before upgrading.
201201
1. Document customization for containerModes [#2777](https://github.com/actions/actions-runner-controller/pull/2777)
202202
1. Bump github.com/cloudflare/circl from 1.1.0 to 1.3.3 [#2628](https://github.com/actions/actions-runner-controller/pull/2628)
203203
1. chore(deps): bump github.com/stretchr/testify from 1.8.2 to 1.8.4 [#2716](https://github.com/actions/actions-runner-controller/pull/2716)
204-
1. Move gha-* docs out of preview [#2779](https://github.com/actions/actions-runner-controller/pull/2779)
204+
1. Move gha-\* docs out of preview [#2779](https://github.com/actions/actions-runner-controller/pull/2779)
205205
1. Prepare 0.5.0 release [#2783](https://github.com/actions/actions-runner-controller/pull/2783)
206206
1. Security fix [#2676](https://github.com/actions/actions-runner-controller/pull/2676)
207207

0 commit comments

Comments
 (0)