Skip to content

Commit abd2ded

Browse files
RavlenRoshni Sarangadharan
authored and
Roshni Sarangadharan
committed
Update links to docs from runner docs
Full URL links to docs have changed.
1 parent 72a6a99 commit abd2ded

37 files changed

+144
-146
lines changed

docs/_index.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Self-managed runners are GitLab Runner instances that you install, configure, an
2727
infrastructure.
2828
You can [install](install/_index.md) and register self-managed runners on all GitLab installations.
2929

30-
Unlike [GitLab-hosted runners](https://docs.gitlab.com/ee/ci/runners/index.html), which are hosted and managed by GitLab, you have complete control over self-managed runners.
30+
Unlike [GitLab-hosted runners](https://docs.gitlab.com/ci/runners/), which are hosted and managed by GitLab, you have complete control over self-managed runners.
3131

3232
### Use Terraform to create and manage a fleet of runners
3333

@@ -94,7 +94,7 @@ These are only a few of the possible configurations. You can install GitLab Runn
9494
on a virtual machine and have it use another virtual machine as an executor.
9595

9696
When you install GitLab Runner in a Docker container and choose the
97-
[Docker executor](https://docs.gitlab.com/ee/ci/docker/using_docker_images.html)
97+
[Docker executor](https://docs.gitlab.com/ci/docker/using_docker_images/)
9898
to run your jobs, it's sometimes referred to as a "Docker-in-Docker" configuration.
9999

100100
### Who has access to runners in the GitLab UI
@@ -104,16 +104,16 @@ should have access to it, or if you want to limit it to a specific GitLab group
104104

105105
There are three types of runners, based on who you want to have access:
106106

107-
- [Instance runners](https://docs.gitlab.com/ee/ci/runners/runners_scope.html#instance-runners) are for use by all projects
108-
- [Group runners](https://docs.gitlab.com/ee/ci/runners/runners_scope.html#group-runners) are for all projects and subgroups in a group
109-
- [Project runners](https://docs.gitlab.com/ee/ci/runners/runners_scope.html#project-runners) are for individual projects
107+
- [Instance runners](https://docs.gitlab.com/ci/runners/runners_scope/#instance-runners) are for use by all projects
108+
- [Group runners](https://docs.gitlab.com/ci/runners/runners_scope/#group-runners) are for all projects and subgroups in a group
109+
- [Project runners](https://docs.gitlab.com/ci/runners/runners_scope/#project-runners) are for individual projects
110110

111111
The scope of a runner is defined during the registration.
112112
This is how the runner knows which projects it's available for.
113113

114114
### Tags
115115

116-
When you register a runner, you can add [**tags**](https://docs.gitlab.com/ee/ci/yaml/index.html#tags) to it.
116+
When you register a runner, you can add [**tags**](https://docs.gitlab.com/ci/yaml/#tags) to it.
117117

118118
When a CI/CD job runs, it knows which runner to use by looking at the assigned tags.
119119
Tags are the only way to filter the list of available runners for a job.
@@ -148,7 +148,7 @@ much CPU your runners are using.
148148
### Use a runner to run jobs
149149

150150
After a runner is configured and available for your project, your
151-
[CI/CD](https://docs.gitlab.com/ee/ci/index.html) jobs can use the runner.
151+
[CI/CD](https://docs.gitlab.com/ci/) jobs can use the runner.
152152

153153
## Features
154154

@@ -176,7 +176,7 @@ GitLab Runner has the following features.
176176

177177
## Runner execution flow
178178

179-
This diagram shows how runners are registered and how jobs are requested and handled. It also shows which actions use [registration, authentication](https://docs.gitlab.com/ee/api/runners.html#registration-and-authentication-tokens), and [job tokens](https://docs.gitlab.com/ee/ci/jobs/ci_job_token.html).
179+
This diagram shows how runners are registered and how jobs are requested and handled. It also shows which actions use [registration, authentication](https://docs.gitlab.com/api/runners/#registration-and-authentication-tokens), and [job tokens](https://docs.gitlab.com/ci/jobs/ci_job_token/).
180180

181181
```mermaid
182182
sequenceDiagram
@@ -212,7 +212,7 @@ This glossary provides definitions for terms related to GitLab Runner.
212212
- **machine**: A virtual machine (VM) or pod that the runner operates in.
213213
GitLab Runner automatically generates a unique, persistent machine ID so that when multiple machines are given the same runner configuration, jobs can be routed separately but the runner configurations are grouped in the UI.
214214

215-
See also the official [GitLab Word List](https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#gitlab-runner) and the GitLab Architecture entry for [GitLab Runner](https://docs.gitlab.com/ee/development/architecture.html#gitlab-runner).
215+
See also the official [GitLab Word List](https://docs.gitlab.com/development/documentation/styleguide/word_list/#gitlab-runner) and the GitLab Architecture entry for [GitLab Runner](https://docs.gitlab.com/development/architecture/#gitlab-runner).
216216

217217
## Troubleshooting
218218

docs/commands/_index.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ These commands support the following arguments:
216216

217217
### `gitlab-runner register`
218218

219-
This command registers your runner in GitLab by using the GitLab [Runners API](https://docs.gitlab.com/ee/api/runners.html#register-a-new-runner).
219+
This command registers your runner in GitLab by using the GitLab [Runners API](https://docs.gitlab.com/api/runners/#register-a-new-runner).
220220

221221
The registered runner is
222222
added to the [configuration file](#configuration-file).
@@ -231,7 +231,7 @@ You can register a runner:
231231

232232
{{< alert type="note" >}}
233233

234-
Runners can be registered directly by using the GitLab [Runners API](https://docs.gitlab.com/ee/api/runners.html#register-a-new-runner) but
234+
Runners can be registered directly by using the GitLab [Runners API](https://docs.gitlab.com/api/runners/#register-a-new-runner) but
235235
configuration is not generated automatically.
236236

237237
{{< /alert >}}
@@ -331,7 +331,7 @@ gitlab-runner verify --delete
331331

332332
### `gitlab-runner unregister`
333333

334-
This command unregisters registered runners by using the GitLab [Runners API](https://docs.gitlab.com/ee/api/runners.html#delete-a-registered-runner).
334+
This command unregisters registered runners by using the GitLab [Runners API](https://docs.gitlab.com/api/runners/#delete-a-runner).
335335

336336
It expects either:
337337

@@ -342,7 +342,7 @@ With the `--all-runners` option, it unregisters all the attached runners.
342342

343343
{{< alert type="note" >}}
344344

345-
Runners can be unregistered with the GitLab [Runners API](https://docs.gitlab.com/ee/api/runners.html#delete-a-runner) but the
345+
Runners can be unregistered with the GitLab [Runners API](https://docs.gitlab.com/api/runners/#delete-a-runner) but the
346346
configuration is not modified for the user.
347347

348348
{{< /alert >}}
@@ -351,8 +351,8 @@ configuration is not modified for the user.
351351
with the runner authentication token deletes the runner.
352352
- If the runner was created in the GitLab UI or with the Runners API, `gitlab-runner unregister`
353353
with the runner authentication token deletes the runner manager, but not the runner.
354-
To completely remove the runner, [delete the runner in the runners administration page](https://docs.gitlab.com/ee/ci/runners/runners_scope.html#delete-shared-runners)
355-
or use the [`DELETE /runners`](https://docs.gitlab.com/ee/api/runners.html#delete-a-runner) REST API endpoint.
354+
To completely remove the runner, [delete the runner in the runners administration page](https://docs.gitlab.com/ci/runners/runners_scope/#delete-instance-runners)
355+
or use the [`DELETE /runners`](https://docs.gitlab.com/api/runners/#delete-a-runner) REST API endpoint.
356356

357357
To unregister a single runner, first get the runner's details by executing
358358
`gitlab-runner list`:
@@ -397,8 +397,8 @@ gitlab-runner unregister --all-runners
397397
### `gitlab-runner reset-token`
398398

399399
This command resets a runner's token by using the GitLab Runners API, with
400-
either the [runner ID](https://docs.gitlab.com/ee/api/runners.html#reset-runners-authentication-token-by-using-the-runner-id)
401-
or the [current token](https://docs.gitlab.com/ee/api/runners.html#reset-runners-authentication-token-by-using-the-current-token).
400+
either the [runner ID](https://docs.gitlab.com/api/runners/#reset-runners-authentication-token-by-using-the-runner-id)
401+
or the [current token](https://docs.gitlab.com/api/runners/#reset-runners-authentication-token-by-using-the-current-token).
402402

403403
It expects the runner's name (or URL and ID), and an optional PAT if
404404
resetting by runner ID. The PAT and runner ID are intended to be used if the

0 commit comments

Comments
 (0)