Skip to content

Commit 0672ff0

Browse files
knkarthikmumoshu
andauthored
FIx broken links in documentation (actions#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>
1 parent f2f2282 commit 0672ff0

File tree

4 files changed

+12
-11
lines changed

4 files changed

+12
-11
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
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.
66

7-
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).
7+
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).
88

99
The process would look like the below:
1010

docs/Actions-Runner-Controller-Overview.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ Self-hosted runners can be physical, virtual, in a container, on-premises, or in
2929
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.
3030

3131
### Deploying ARC
32-
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)."
32+
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)."
33+
3334

3435
## ARC components
3536
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
5253

5354

5455
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
55-
For more details, see "[QuickStart Guide](https://github.com/actions-runner-controller/actions-runner-controller/blob/master/QuickStartGuide.md)."
56+
For more details, see "[QuickStart Guide](QuickStartGuide.md)."
5657

5758
```yaml
5859
apiVersion: actions.summerwind.dev/v1alpha1
@@ -119,7 +120,7 @@ spec:
119120
scaleDownFactor: '0.5'
120121
```
121122

122-
For more details - please see "[Pull Driven Scaling](https://github.com/actions-runner-controller/actions-runner-controller#pull-driven-scaling)."
123+
For more details - please see "[Pull Driven Scaling](detailed-docs.md#pull-driven-scaling)."
123124

124125
*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.*
125126

docs/QuickStartGuide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ GitHub documentation lists the steps to target Actions against self hosted runne
127127
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)."
128128
129129
## Next steps
130-
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)."
130+
ARC provides several interesting features and capabilities. For more information, see "[Detailed documentation](detailed-docs.md)."
131131
132132
133133

docs/detailed-docs.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ kubectl create -f https://github.com/actions-runner-controller/actions-runner-co
102102

103103
**Helm Deployment:**
104104

105-
Configure your values.yaml, see the chart's [README](./charts/actions-runner-controller/README.md) for the values documentation
105+
Configure your values.yaml, see the chart's [README](../charts/actions-runner-controller/README.md) for the values documentation
106106

107107
```shell
108108
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 \
209209

210210
**Helm Deployment:**
211211

212-
Configure your values.yaml, see the chart's [README](./charts/actions-runner-controller/README.md) for deploying the secret via Helm
212+
Configure your values.yaml, see the chart's [README](../charts/actions-runner-controller/README.md) for deploying the secret via Helm
213213

214214
### Deploying Using PAT Authentication
215215

@@ -253,7 +253,7 @@ kubectl create secret generic controller-manager \
253253

254254
**Helm Deployment:**
255255

256-
Configure your values.yaml, see the chart's [README](./charts/actions-runner-controller/README.md) for deploying the secret via Helm
256+
Configure your values.yaml, see the chart's [README](../charts/actions-runner-controller/README.md) for deploying the secret via Helm
257257

258258
### Deploying Multiple Controllers
259259

@@ -763,7 +763,7 @@ Your `HRA.spec.scaleUpTriggers[].duration` value should be set long enough to ac
763763
##### Install with Helm
764764

765765
To enable this feature, you first need to install the GitHub webhook server. To install via our Helm chart,
766-
_[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)_
766+
_[see the values documentation for all configuration options](../charts/actions-runner-controller/README.md)_
767767

768768
```console
769769
$ helm upgrade --install --namespace actions-runner-system --create-namespace \
@@ -1802,8 +1802,8 @@ Please refer to [Deploying Using GitHub App Authentication](#deploying-using-git
18021802

18031803
# Troubleshooting
18041804

1805-
See [troubleshooting guide](TROUBLESHOOTING.md) for solutions to various problems people have run into consistently.
1805+
See [troubleshooting guide](../TROUBLESHOOTING.md) for solutions to various problems people have run into consistently.
18061806

18071807
# Contributing
18081808

1809-
For more details on contributing to the project (including requirements) please check out [Getting Started with Contributing](CONTRIBUTING.md).
1809+
For more details on contributing to the project (including requirements) please check out [Getting Started with Contributing](../CONTRIBUTING.md).

0 commit comments

Comments
 (0)