From a6c4d84234cc35a010724c0242900c45c4b87baf Mon Sep 17 00:00:00 2001 From: Siara <108543037+SiaraMist@users.noreply.github.com> Date: Thu, 12 Jan 2023 02:37:58 -0800 Subject: [PATCH] Fix broken links in docs (#2144) --- CONTRIBUTING.md | 2 +- README.md | 2 +- docs/about-arc.md | 2 +- docs/quickstart.md | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d236d779..2399a8ce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -201,7 +201,7 @@ The maintainers will manage releases and publishing new charts. 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](docs/detailed-docs.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/about-arc.md#github-enterprise-support). The process would look like the below: diff --git a/README.md b/README.md index dd14c3a5..338a7405 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ The documentation is kept inline with master@HEAD, we do our best to highlight a ## Getting Started To give ARC a try with just a handful of commands, Please refer to the [Quickstart guide](/docs/quickstart.md). -For an overview of ARC, please refer to [ARC Overview](https://github.com/actions/actions-runner-controller/blob/master/docs/Actions-Runner-Controller-Overview.md) +For an overview of ARC, please refer to [About ARC](https://github.com/actions/actions-runner-controller/blob/master/docs/about-arc.md) For more information, please refer to detailed documentation below! diff --git a/docs/about-arc.md b/docs/about-arc.md index ce621d04..532d29f0 100644 --- a/docs/about-arc.md +++ b/docs/about-arc.md @@ -122,7 +122,7 @@ spec: scaleDownFactor: '0.5' ``` -For more details - please see "[Pull Driven Scaling](detailed-docs.md#pull-driven-scaling)." +For more details - please see "[Pull Driven Scaling](automatically-scaling-runners.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.* diff --git a/docs/quickstart.md b/docs/quickstart.md index 04eb567e..013cfc5f 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -12,7 +12,7 @@ With ARC you can : ## Overview -For an overview of ARC, please refer to "[ARC Overview](https://github.com/actions/actions-runner-controller/blob/master/docs/Actions-Runner-Controller-Overview.md)." +For an overview of ARC, please refer to "[About ARC](https://github.com/actions/actions-runner-controller/blob/master/docs/about-arc.md)." ## Getting Started @@ -140,7 +140,7 @@ There is also a quick start guide to get started on Actions, For more informatio ## Learn more -For more detailed documentation, please refer to "[Detailed Documentation](https://github.com/actions/actions-runner-controller/blob/master/docs/detailed-docs.md)." +For more detailed documentation, please refer to "[Actions Runner Controller Documentation](https://github.com/actions/actions-runner-controller/blob/master/README.md#documentation)." ## Contributing