public_git
/
actions-runner-controller
mirror of https://github.com/actions-runner-controller/actions-runner-controller.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

FIx broken links in documentation (#1882) 

* Fix links on Actions-Runner-Controller-Overview.md

* Fix link on QuickStartGuide.md

* Fix link on Contributing.md

* Fix links on detailed-docs.md

* Update CONTRIBUTING.md

* Update docs/Actions-Runner-Controller-Overview.md

* Update docs/Actions-Runner-Controller-Overview.md

* Update docs/QuickStartGuide.md

* Update docs/Actions-Runner-Controller-Overview.md

Co-authored-by: Yusuke Kuoka <ykuoka@gmail.com>
This commit is contained in:
Karthik KN 2022-09-29 20:53:32 -04:00 committed by GitHub
parent f2f22827a6
commit 0672ff0ff9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -4,7 +4,7 @@
We always appreciate your help in testing open pull requests by deploying custom builds of actions-runner-controller onto your own environment, so that we are extra sure we didn't break anything. We always appreciate your help in testing open pull requests by deploying custom builds of actions-runner-controller onto your own environment, so that we are extra sure we didn't break anything.
It is especially true when the pull request is about GitHub Enterprise, both GHEC and GHES, as [maintainers don't have GitHub Enterprise environments for testing](/README.md#github-enterprise-support). It is especially true when the pull request is about GitHub Enterprise, both GHEC and GHES, as [maintainers don't have GitHub Enterprise environments for testing](docs/detailed-docs.md#github-enterprise-support).
The process would look like the below: The process would look like the below:

7
docs/Actions-Runner-Controller-Overview.md
View File

@ -29,7 +29,8 @@ Self-hosted runners can be physical, virtual, in a container, on-premises, or in
ARC is a K8s controller to create self-hosted runners on your K8s cluster. With few commands, you can set up self hosted runners that can scale up and down based on demand. And since these could be ephemeral and based on containers, new instances of the runner can be brought up rapidly and cleanly. ARC is a K8s controller to create self-hosted runners on your K8s cluster. With few commands, you can set up self hosted runners that can scale up and down based on demand. And since these could be ephemeral and based on containers, new instances of the runner can be brought up rapidly and cleanly.
### Deploying ARC ### Deploying ARC
We have a quick start guide that demonstrates how to easily deploy ARC into your K8s environment. For more details, see "[QuickStart Guide](https://github.com/actions-runner-controller/actions-runner-controller/blob/master/QuickStartGuide.md)." We have a quick start guide that demonstrates how to easily deploy ARC into your K8s environment. For more details, see "[QuickStart Guide](QuickStartGuide.md)."
## ARC components ## ARC components
ARC basically consists of a set of custom resources. An ARC deployment is applying these custom resources onto a K8s cluster. Once applied, it creates a set of Pods, with the Github Actions runner running within them. Github is now able to treat these Pods as self hosted runners and allocate jobs to them. ARC basically consists of a set of custom resources. An ARC deployment is applying these custom resources onto a K8s cluster. Once applied, it creates a set of Pods, with the Github Actions runner running within them. Github is now able to treat these Pods as self hosted runners and allocate jobs to them.
@ -52,7 +53,7 @@ Once the custom resources are installed, another command deploys ARC into your K
The `Deployment and Configure ARC` section in the `Quick Start guide` lists the steps to deploy ARC using a `runnerdeployment.yaml` file. Here, we will explain the details The `Deployment and Configure ARC` section in the `Quick Start guide` lists the steps to deploy ARC using a `runnerdeployment.yaml` file. Here, we will explain the details
For more details, see "[QuickStart Guide](https://github.com/actions-runner-controller/actions-runner-controller/blob/master/QuickStartGuide.md)." For more details, see "[QuickStart Guide](QuickStartGuide.md)."
```yaml ```yaml
apiVersion: actions.summerwind.dev/v1alpha1 apiVersion: actions.summerwind.dev/v1alpha1
@ -119,7 +120,7 @@ spec:
scaleDownFactor: '0.5' scaleDownFactor: '0.5'
``` ```
For more details - please see "[Pull Driven Scaling](https://github.com/actions-runner-controller/actions-runner-controller#pull-driven-scaling)." For more details - please see "[Pull Driven Scaling](detailed-docs.md#pull-driven-scaling)."
*The period between polls is defined by the controller's `--sync-period` flag. If this flag isn't provided then the controller defaults to a sync period of `1m`, this can be configured in seconds or minutes.* *The period between polls is defined by the controller's `--sync-period` flag. If this flag isn't provided then the controller defaults to a sync period of `1m`, this can be configured in seconds or minutes.*

2
docs/QuickStartGuide.md
View File

@ -127,7 +127,7 @@ GitHub documentation lists the steps to target Actions against self hosted runne
There's also has a quick start guide to get started on Actions, For more information, see "[Quick start Guide to GitHub Actions](https://docs.github.com/en/actions/quickstart)." There's also has a quick start guide to get started on Actions, For more information, see "[Quick start Guide to GitHub Actions](https://docs.github.com/en/actions/quickstart)."
## Next steps ## Next steps
ARC provides several interesting features and capabilities. For more information, see "[Readme](https://github.com/actions-runner-controller/actions-runner-controller/blob/master/README.md)." ARC provides several interesting features and capabilities. For more information, see "[Detailed documentation](detailed-docs.md)."

12
docs/detailed-docs.md
View File

@ -102,7 +102,7 @@ kubectl create -f https://github.com/actions-runner-controller/actions-runner-co
**Helm Deployment:** **Helm Deployment:**
Configure your values.yaml, see the chart's [README](./charts/actions-runner-controller/README.md) for the values documentation Configure your values.yaml, see the chart's [README](../charts/actions-runner-controller/README.md) for the values documentation
```shell ```shell
helm repo add actions-runner-controller https://actions-runner-controller.github.io/actions-runner-controller helm repo add actions-runner-controller https://actions-runner-controller.github.io/actions-runner-controller
@ -209,7 +209,7 @@ $ kubectl create secret generic controller-manager \
**Helm Deployment:** **Helm Deployment:**
Configure your values.yaml, see the chart's [README](./charts/actions-runner-controller/README.md) for deploying the secret via Helm Configure your values.yaml, see the chart's [README](../charts/actions-runner-controller/README.md) for deploying the secret via Helm
### Deploying Using PAT Authentication ### Deploying Using PAT Authentication
@ -253,7 +253,7 @@ kubectl create secret generic controller-manager \
**Helm Deployment:** **Helm Deployment:**
Configure your values.yaml, see the chart's [README](./charts/actions-runner-controller/README.md) for deploying the secret via Helm Configure your values.yaml, see the chart's [README](../charts/actions-runner-controller/README.md) for deploying the secret via Helm
### Deploying Multiple Controllers ### Deploying Multiple Controllers
@ -763,7 +763,7 @@ Your `HRA.spec.scaleUpTriggers[].duration` value should be set long enough to ac
##### Install with Helm ##### Install with Helm
To enable this feature, you first need to install the GitHub webhook server. To install via our Helm chart, To enable this feature, you first need to install the GitHub webhook server. To install via our Helm chart,
_[see the values documentation for all configuration options](https://github.com/actions-runner-controller/actions-runner-controller/blob/master/charts/actions-runner-controller/README.md)_ _[see the values documentation for all configuration options](../charts/actions-runner-controller/README.md)_
```console ```console
$ helm upgrade --install --namespace actions-runner-system --create-namespace \ $ helm upgrade --install --namespace actions-runner-system --create-namespace \
@ -1802,8 +1802,8 @@ Please refer to [Deploying Using GitHub App Authentication](#deploying-using-git
# Troubleshooting # Troubleshooting
See [troubleshooting guide](TROUBLESHOOTING.md) for solutions to various problems people have run into consistently. See [troubleshooting guide](../TROUBLESHOOTING.md) for solutions to various problems people have run into consistently.
# Contributing # 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).