Skip to content

Commit 35906f4

Browse files
RavlenLeala Smith
andcommitted
Merge branch 'lealasmith-hugo-migration-update-links-runner' into 'main'
Docs: Hugo migration - Updating gitlab-runner doc links See merge request https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/5448 Merged-by: Marcel Amirault <[email protected]> Approved-by: Georgi N. Georgiev <[email protected]> Approved-by: Marcel Amirault <[email protected]> Reviewed-by: Marcel Amirault <[email protected]> Co-authored-by: Leala Smith <[email protected]>
2 parents f7fafba + ed851f8 commit 35906f4

28 files changed

+70
-75
lines changed

.gitlab/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# When adding a group as a code owner, make sure to invite the group to the
22
# project here: https://gitlab.com/gitlab-org/gitlab-runner/-/project_members
3-
# As described in https://docs.gitlab.com/ee/user/project/code_owners.html
3+
# As described in https://docs.gitlab.com/user/project/codeowners/
44

55
* @gitlab-com/runner-maintainers
66
.editorconfig @gitlab-com/runner-group @gitlab-com/runner-maintainers

.gitlab/ci/coverage.gitlab-ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ test coverage report:
3535
# Disable this for now since
3636
# https://gitlab.com/gitlab-org/gitlab/-/issues/365885 block us from upgrading
3737
# to go 1.18.x. Re-enable this when the above ticket is fixed.
38-
#code navigation: # See https://docs.gitlab.com/ee/user/project/code_intelligence.html#configuration
38+
#code navigation: # See https://docs.gitlab.com/user/project/code_intelligence/#configuration
3939
#extends:
4040
#- .coverage_job
4141
#allow_failure: true # recommended

.gitlab/issue_templates/Documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
https://gitlab.com/gitlab-org/gitlab-docs/issues/
77
88
* For information about documentation content and process, see
9-
https://docs.gitlab.com/ee/development/documentation/ -->
9+
https://docs.gitlab.com/development/documentation/ -->
1010

1111
### Problem to solve
1212

.gitlab/issue_templates/Security developer workflow.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ After your merge request has been approved according to our [approval guidelines
5959

6060
[security process for developers]: https://gitlab.com/gitlab-org/release/docs/blob/master/general/security/developer.md
6161
[security Release merge request template]: https://gitlab.com/gitlab-org/security/gitlab-runner/blob/main/.gitlab/merge_request_templates/Security%20Release.md
62-
[approval guidelines]: https://docs.gitlab.com/ee/development/code_review.html#approval-guidelines
63-
[issue as related]: https://docs.gitlab.com/ee/user/project/issues/related_issues.html#adding-a-related-issue
62+
[approval guidelines]: https://docs.gitlab.com/development/code_review/#approval-guidelines
63+
[issue as related]: https://docs.gitlab.com/user/project/issues/related_issues/#add-a-linked-issue
6464

6565
/label ~security ~"Category:Runner" ~"devops::verify" ~"group::runner"
6666

.gitlab/issue_templates/trainee-backend-maintainer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
## Basic setup
66

77
1. [ ] Read the [Becoming a maintainer for one of Runner team projects](https://about.gitlab.com/handbook/engineering/development/ci-cd/verify/runner/#becoming-a-maintainer-for-one-of-our-projects).
8-
1. [ ] Read the [code review page in the handbook](https://about.gitlab.com/handbook/engineering/workflow/code-review/) and the [code review guidelines](https://docs.gitlab.com/ee/development/code_review.html).
8+
1. [ ] Read the [code review page in the handbook](https://about.gitlab.com/handbook/engineering/workflow/code-review/) and the [code review guidelines](https://docs.gitlab.com/development/code_review/).
99
1. [ ] Understand [how to become a maintainer](https://about.gitlab.com/handbook/engineering/workflow/code-review/#how-to-become-a-maintainer).
1010
1. [ ] Add yourself as a [trainee maintainer](https://about.gitlab.com/handbook/engineering/workflow/code-review/#trainee-maintainer) on the [team page](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/team.yml).
1111
1. [ ] Ask your manager to set up a check in on this issue every six weeks or so.

.gitlab/merge_request_templates/Documentation.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@
1010

1111
- [ ] Optional. Consider taking [the GitLab Technical Writing Fundamentals course](https://university.gitlab.com/courses/gitlab-technical-writing-fundamentals).
1212
- [ ] Follow the:
13-
- [Documentation process](https://docs.gitlab.com/ee/development/documentation/workflow.html).
14-
- [Documentation guidelines](https://docs.gitlab.com/ee/development/documentation/).
15-
- [Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide/).
16-
- [ ] If you're adding or changing the main heading of the page (H1), ensure that the [product tier badge](https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#product-tier-badges) is added.
17-
- [ ] If you are a GitLab team member, [request a review](https://docs.gitlab.com/ee/development/code_review.html#dogfooding-the-reviewers-feature) based on:
18-
- The documentation page's [metadata](https://docs.gitlab.com/ee/development/documentation/#metadata).
13+
- [Documentation process](https://docs.gitlab.com/development/documentation/workflow/).
14+
- [Documentation guidelines](https://docs.gitlab.com/development/documentation/).
15+
- [Style Guide](https://docs.gitlab.com/development/documentation/styleguide/).
16+
- [ ] If you're adding or changing the main heading of the page (H1), ensure that the [product availability details](https://docs.gitlab.com/development/documentation/styleguide/availability_details/) are added.
17+
- [ ] If you are a GitLab team member, [request a review](https://docs.gitlab.com/development/code_review/#dogfooding-the-reviewers-feature) based on:
18+
- The documentation page's [metadata](https://docs.gitlab.com/development/documentation/metadata/).
1919
- The [associated Technical Writer](https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments).
2020

2121
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
@@ -29,7 +29,7 @@ These labels cause the MR to be added to code verification QA issues.
2929

3030
## Reviewer's checklist
3131

32-
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on [Documentation Guidelines](https://docs.gitlab.com/ee/development/documentation/) and the [Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide/).
32+
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on [Documentation Guidelines](https://docs.gitlab.com/development/documentation/) and the [Style Guide](https://docs.gitlab.com/development/documentation/styleguide/).
3333

3434
If you aren't sure which tech writer to ask, use [roulette](https://gitlab-org.gitlab.io/gitlab-roulette/?sortKey=stats.avg30&order=-1&hourFormat24=true&visible=maintainer%7Cdocs) or ask in the [#docs](https://gitlab.slack.com/archives/C16HYA2P5) Slack channel.
3535

@@ -38,7 +38,7 @@ If you aren't sure which tech writer to ask, use [roulette](https://gitlab-org.g
3838
- [ ] Ensure docs metadata is present and up-to-date.
3939
- [ ] Ensure the appropriate [labels](https://about.gitlab.com/handbook/product/ux/technical-writing/workflow/#labels) are added to this MR.
4040
- [ ] Ensure a release milestone is set.
41-
- If relevant to this MR, ensure [content topic type](https://docs.gitlab.com/ee/development/documentation/structure.html) principles are in use, including:
41+
- If relevant to this MR, ensure [content topic type](https://docs.gitlab.com/development/documentation/topic_types/) principles are in use, including:
4242
- [ ] The headings should be something you'd do a Google search for. Instead of `Default behavior`, say something like `Default behavior when you close an issue`.
4343
- [ ] The headings (other than the page title) should be active. Instead of `Configuring GDK`, say something like `Configure GDK`.
4444
- [ ] Any task steps should be written as a numbered list.

.gitlab/merge_request_templates/Security Release.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ See [the general developer security release guidelines](https://gitlab.com/gitla
4141
/label ~security ~"Category:Runner" ~"devops::verify" ~"group::runner"
4242

4343
[GitLab Runner Security]: https://gitlab.com/gitlab-org/security/gitlab-runner
44-
[quick actions]: https://docs.gitlab.com/ee/user/project/quick_actions.html#quick-actions-for-issues-merge-requests-and-epics
45-
[Code Review process]: https://docs.gitlab.com/ee/development/code_review.html
46-
[Approval Guidelines]: https://docs.gitlab.com/ee/development/code_review.html#approval-guidelines
44+
[quick actions]: https://docs.gitlab.com/user/project/quick_actions/#quick-actions-for-issues-merge-requests-and-epics
45+
[Code Review process]: https://docs.gitlab.com/development/code_review/
46+
[Approval Guidelines]: https://docs.gitlab.com/development/code_review/#approval-guidelines
4747
[Canonical repository]: https://gitlab.com/gitlab-org/gitlab-runner
4848
[security release tracking issue]: https://gitlab.com/gitlab-org/gitlab/-/issues/?scope=all&utf8=%E2%9C%93&state=opened&label_name%5B%5D=upcoming%20security%20release
4949

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4502,7 +4502,7 @@ All deprecations, with a detailed description, are listed at
45024502
<https://about.gitlab.com/2019/04/22/gitlab-11-10-released/#release-deprecations>
45034503

45044504
1. With version 11.10 we're deprecating the feature flag
4505-
[FF_USE_LEGACY_GIT_CLEAN_STRATEGY](https://docs.gitlab.com/runner/configuration/feature-flags.html#available-feature-flags).
4505+
[FF_USE_LEGACY_GIT_CLEAN_STRATEGY](https://docs.gitlab.com/runner/configuration/feature-flags/#available-feature-flags).
45064506

45074507
**Release changes:**
45084508

@@ -4581,7 +4581,7 @@ All deprecations, with a detailed description, are listed at
45814581
configuration structure will be removed.
45824582

45834583
5. With version 11.4 we've fixed the way how `entrypoint:` and `command:` options of
4584-
Extended Docker configuration (<https://docs.gitlab.com/ee/ci/docker/using_docker_images.html#extended-docker-configuration-options>)
4584+
Extended Docker configuration (<https://docs.gitlab.com/ci/docker/using_docker_images/#extended-docker-configuration-options>)
45854585
are being handled by Kubernetes Executor. The previous implementation was wrong and
45864586
was making the configuration unusable in most cases. However some users could relay
45874587
on this wrong behavior. Because of that we've added a feature flag `FF_K8S_USE_ENTRYPOINT_OVER_COMMAND`
@@ -5719,7 +5719,7 @@ that even in edge cases you can always rely on them.
57195719
- Add internal command for uploading artifacts without the system dependencies
57205720
- Use umask in Docker build containers to fix running jobs as specific user
57215721
- Fix problem with `cache` paths never being archived
5722-
- Add support for [`cache:key`](http://doc.gitlab.com/ce/ci/yaml/index.html#cachekey)
5722+
- Add support for [`cache:key`](https://docs.gitlab.com/ci/yaml/#cachekey)
57235723
- Add warnings about using runner in `user-mode`
57245724
- Push packages to all upcoming distributions (Debian/Ubuntu/Fedora)
57255725
- Rewrite the shell support adding all features to all shells (makes possible to use artifacts and caching on Windows)

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,19 @@ _This notice should stay as the first item in the CONTRIBUTING.md file._
1919

2020
## Contribute to GitLab Runner
2121

22-
The following content is an extension of the [GitLab contribution guidelines](https://docs.gitlab.com/ce/development/contributing/index.html).
22+
The following content is an extension of the [GitLab contribution guidelines](https://docs.gitlab.com/development/contributing/).
2323

2424
### How we prioritize MRs from the wider community
2525

26-
Currently we use a system of [scoped labels](https://docs.gitlab.com/ee/user/project/labels.html#scoped-labels-premium) to help us prioritize which MRs our team will review.
26+
Currently we use a system of [scoped labels](https://docs.gitlab.com/user/project/labels/#scoped-labels) to help us prioritize which MRs our team will review.
2727

2828
| Label | Meaning | Use Cases |
2929
| ---- | ----- | ----- |
3030
| ~"Review::P1" | Highest priority to review. | Indicates a merge request that might solve an urgent pain point for users, contributes to the strategic direction of Runner development as laid out by the Product team, or fixes a critical issue. A hard cap on the number of contributions labelled ~"Review::P1" is set at 3. |
3131
| ~"Review::P2" | Important merge requests. | When a merge request is important, but has lower impact to customers when compared to merge requests labelled ~"Review::P1". |
3232
| ~"Review::P3" | Default priority to review. | All incoming merge requests should default to this. |
3333

34-
### Contributing new features that need new or updated `.gitlab-ci.yml` [keywords](https://docs.gitlab.com/ee/ci/yaml/)
34+
### Contributing new features that need new or updated `.gitlab-ci.yml` [keywords](https://docs.gitlab.com/ci/yaml/)
3535

3636
To execute a job, the GitLab instance processes the `gitlab-ci.yml` configuration
3737
and creates a data transfer object, containing only data relevant to a job's
@@ -101,12 +101,12 @@ acceptable, while `Fix timestamp in docker executor job output` would be accepta
101101

102102
### Workflow labels
103103

104-
We have some additional labels plus those defined in [gitlab-ce workflow labels](https://docs.gitlab.com/ce/development/contributing/issue_workflow.html)
104+
We have some additional labels plus those defined in [gitlab-ce workflow labels](https://docs.gitlab.com/development/contributing/issue_workflow/)
105105

106106
- Additional subjects: ~cache, ~executors, ~"git operations"
107107
- OS: ~"os::Linux" ~"os::macOS" ~"os::FreeBSD" ~"os::Windows"
108108
- executor: ~"executor::docker" ~"executor::kubernetes" ~"executor::docker\-machine" ~"executor::shell" ~"executor::parallels" ~"executor::virtualbox"
109109
- For any [follow-up
110-
issues](https://docs.gitlab.com/ee/development/contributing/issue_workflow.html#technical-debt-in-follow-up-issues)
110+
issues](https://docs.gitlab.com/development/contributing/issue_workflow/#technical-debt-in-follow-up-issues)
111111
created during code review the ~"follow-up" label should be added to
112112
keep track of it.

0 commit comments

Comments
 (0)