docs: using better english

This commit is contained in:
toast-gear
2021-08-06 17:32:58 +01:00
committed by GitHub
parent 743e6d6202
commit 3948406374

View File

@@ -1,4 +1,4 @@
# actions-runner-controller
l# actions-runner-controller
[![awesome-runners](https://img.shields.io/badge/listed%20on-awesome--runners-blue.svg)](https://github.com/jonico/awesome-runners)
@@ -86,7 +86,7 @@ There are two ways for actions-runner-controller to authenticate with the GitHub
Functionality wise, there isn't much of a difference between the 2 authentication methods. The primarily benefit of authenticating via a GitHub App is an [increased API quota](https://docs.github.com/en/developers/apps/rate-limits-for-github-apps).
If you are deploying the solution for a GitHub Enterprise Server environment you are able to [configure your rate limiting settings](https://docs.github.com/en/enterprise-server@3.0/admin/configuration/configuring-rate-limits) making the main benefit irrelevant. If you're deploying the solution for a GitHub Enterprise Cloud or regular GitHub environment and you run into rate limiting issues, consider deploying the solution using the GitHub App authentication method instead.
If you are deploying the solution for a GitHub Enterprise Server environment you are able to [configure your rate limit settings](https://docs.github.com/en/enterprise-server@3.0/admin/configuration/configuring-rate-limits) making the main benefit irrelevant. If you're deploying the solution for a GitHub Enterprise Cloud or regular GitHub environment and you run into rate limiting issues, consider deploying the solution using the GitHub App authentication method instead.
### Deploying Using GitHub App Authentication
@@ -1135,4 +1135,4 @@ spec:
# Contributing
For more details on contributing to the project (including requirements) please check out [Getting Started with Contributing](CONTRIBUTING.md).
For more details on contributing to the project (including requirements) please check out [Getting Started with Contributing](CONTRIBUTING.md).