diff --git a/data/deprecations/14-3-repository-push-audit-events.yml b/data/deprecations/14-3-repository-push-audit-events.yml index 9682c2ddd2c1deb0f16e6681097458e8505d1d7c..1bbbe0c49e36e522de84d618f39dbe22a480d49b 100644 --- a/data/deprecations/14-3-repository-push-audit-events.yml +++ b/data/deprecations/14-3-repository-push-audit-events.yml @@ -11,4 +11,4 @@ stage: Foundations tiers: Premium issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/337993 - documentation_url: https://docs.gitlab.com/ee/administration/index.html + documentation_url: https://docs.gitlab.com/ee/administration/ diff --git a/data/deprecations/17-9-spotbugs-builds.yml b/data/deprecations/17-9-spotbugs-builds.yml index 1f23e83b974035ce36bd4a9ac6868ddc26ee93e8..c82babdb2e66a2eed3e0dac00d3042cb0651c160 100644 --- a/data/deprecations/17-9-spotbugs-builds.yml +++ b/data/deprecations/17-9-spotbugs-builds.yml @@ -11,7 +11,7 @@ resolution_role: Developer manual_task: true body: | # (required) Don't change this line. - The SpotBugs [SAST analyzer](https://docs.gitlab.com/ee/user/application_security/sast/index.html#supported-languages-and-frameworks) + The SpotBugs [SAST analyzer](https://docs.gitlab.com/ee/user/application_security/sast/#supported-languages-and-frameworks) can perform a build when the artifacts to be scanned aren't present. While this usually works well for simple projects, it can fail on more complex builds. From GitLab 18.0, to resolve SpotBugs analyzer build failures, you should: diff --git a/doc/.vale/gitlab_base/British.yml b/doc/.vale/gitlab_base/British.yml index 45391d4c9ec401cbb11e569f7ca987b448b78df9..301205388a2fd384d7ec30c122733829c01e065c 100644 --- a/doc/.vale/gitlab_base/British.yml +++ b/doc/.vale/gitlab_base/British.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution message: "Use the US spelling '%s' instead of the British '%s'." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#language vocab: false level: error action: diff --git a/doc/.vale/gitlab_base/CodeblockFences.yml b/doc/.vale/gitlab_base/CodeblockFences.yml index 4941661378a9eaf1f3727199e9db5dd859492a79..27e56a92869df2877f6ed86b11402bb38ffc0991 100644 --- a/doc/.vale/gitlab_base/CodeblockFences.yml +++ b/doc/.vale/gitlab_base/CodeblockFences.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Instead of '%s' for the code block, use yaml, ruby, plaintext, markdown, javascript, shell, go, python, dockerfile, or typescript." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#code-blocks +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#code-blocks vocab: false level: error scope: raw diff --git a/doc/.vale/gitlab_base/HeadingDepth.yml b/doc/.vale/gitlab_base/HeadingDepth.yml index ab9f0fc3ed340df7b9d86c854d99b2700d5994b6..dbc9860f321d409cd2b94ae7c302ef44f8dcaa22 100644 --- a/doc/.vale/gitlab_base/HeadingDepth.yml +++ b/doc/.vale/gitlab_base/HeadingDepth.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Refactor the section or page to avoid headings greater than H5." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#heading-levels-in-markdown +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#heading-levels-in-markdown vocab: false level: suggestion scope: raw diff --git a/doc/.vale/gitlab_base/MeaningfulLinkWords.yml b/doc/.vale/gitlab_base/MeaningfulLinkWords.yml index 1866d8dc39aa9f32b0f76b4c490edfa0646a703b..80bf78437e6efb29efa157baaecd3aada8a96ecc 100644 --- a/doc/.vale/gitlab_base/MeaningfulLinkWords.yml +++ b/doc/.vale/gitlab_base/MeaningfulLinkWords.yml @@ -8,7 +8,7 @@ extends: existence message: "Improve SEO and accessibility by rewriting the link text for '%s'." level: warning ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#text-for-links +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#text-for-links vocab: false scope: raw nonword: true diff --git a/doc/.vale/gitlab_base/MultiLineLinks.yml b/doc/.vale/gitlab_base/MultiLineLinks.yml index b43db78bc9666a63452a7506da0c07115f9e2e64..dd6bb499f464dfe3f0540adc92be6c7dafafc896 100644 --- a/doc/.vale/gitlab_base/MultiLineLinks.yml +++ b/doc/.vale/gitlab_base/MultiLineLinks.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Put the full link on one line, even if the link is very long." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#links vocab: false level: error scope: raw diff --git a/doc/.vale/gitlab_base/NonStandardQuotes.yml b/doc/.vale/gitlab_base/NonStandardQuotes.yml index 0e969490d264949fc44dea260ab4dc24265d22b2..b7458731cadc82bf070d7166471bd8b844027f24 100644 --- a/doc/.vale/gitlab_base/NonStandardQuotes.yml +++ b/doc/.vale/gitlab_base/NonStandardQuotes.yml @@ -9,7 +9,7 @@ message: "Use standard single quotes or double quotes only. Do not use left or r vocab: false level: warning ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#punctuation scope: raw raw: - '[‘’“â€]' diff --git a/doc/.vale/gitlab_base/NonStandardSpaces.yml b/doc/.vale/gitlab_base/NonStandardSpaces.yml index 05b5939a2b73e0ee7252135cd88d6e6c9a61cd56..1740d52a305ad77daf374ae78e49dd62435982de 100644 --- a/doc/.vale/gitlab_base/NonStandardSpaces.yml +++ b/doc/.vale/gitlab_base/NonStandardSpaces.yml @@ -13,7 +13,7 @@ message: "Use standard spaces only. Do not use no-break or zero width spaces." vocab: false level: error ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#punctuation scope: raw raw: - '[  ​]' diff --git a/doc/.vale/gitlab_base/OxfordComma.yml b/doc/.vale/gitlab_base/OxfordComma.yml index 928d10db484096aebd82de3e877bd5a4aecb37e4..3801954f25275de0216d51aa3982c81825e568a1 100644 --- a/doc/.vale/gitlab_base/OxfordComma.yml +++ b/doc/.vale/gitlab_base/OxfordComma.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Use a comma before the last 'and' or 'or' in a list of four or more items." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#punctuation vocab: false level: warning raw: diff --git a/doc/.vale/gitlab_base/SentenceLength.yml b/doc/.vale/gitlab_base/SentenceLength.yml index 29dd1084a5d245aa67a11d80d21d393e42e6a4f0..1ad6773b64efd20ec7dd060d412229168d1baaf0 100644 --- a/doc/.vale/gitlab_base/SentenceLength.yml +++ b/doc/.vale/gitlab_base/SentenceLength.yml @@ -7,7 +7,7 @@ extends: occurrence message: "Improve readability by using fewer than 25 words in this sentence." scope: sentence -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#language level: suggestion max: 25 token: \b(\w+)\b diff --git a/doc/.vale/gitlab_base/SentenceSpacing.yml b/doc/.vale/gitlab_base/SentenceSpacing.yml index 45abbcfc763131b70672b1e8591c6ce16e49cec7..ab770cdac59e04e77de5a3de6683247ccc755dde 100644 --- a/doc/.vale/gitlab_base/SentenceSpacing.yml +++ b/doc/.vale/gitlab_base/SentenceSpacing.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Use exactly one space between sentences and clauses. Check '%s' for spacing problems." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#punctuation vocab: false level: error nonword: true diff --git a/doc/.vale/gitlab_docs/AlertBoxStyle.yml b/doc/.vale/gitlab_docs/AlertBoxStyle.yml index 000cca995a45708dab461987f9434e177e40ba58..35d233536cb1e9f7b863cd87e66ae8032cb020f4 100644 --- a/doc/.vale/gitlab_docs/AlertBoxStyle.yml +++ b/doc/.vale/gitlab_docs/AlertBoxStyle.yml @@ -10,7 +10,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Update the format of the '%s' alert box. View the style guide for details." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#alert-boxes +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#alert-boxes vocab: false level: error nonword: true diff --git a/doc/.vale/gitlab_docs/ImagesOld.yml b/doc/.vale/gitlab_docs/ImagesOld.yml index f8029409a50912e553900011fb23e86c2b565c29..6711d58edddd7d2db1fc597d2f28187135770f6c 100644 --- a/doc/.vale/gitlab_docs/ImagesOld.yml +++ b/doc/.vale/gitlab_docs/ImagesOld.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Review this image. It might be out of date." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#anchor-links +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#anchor-links vocab: false level: suggestion scope: raw diff --git a/doc/.vale/gitlab_docs/InternalLinkCase.yml b/doc/.vale/gitlab_docs/InternalLinkCase.yml index 4863db28674bf167a05ad0e655aaa2eb408c9e8a..e19303d4b135e90b466fb5122916f20668d8ce02 100644 --- a/doc/.vale/gitlab_docs/InternalLinkCase.yml +++ b/doc/.vale/gitlab_docs/InternalLinkCase.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Use lowercase for the anchor link." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#anchor-links +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#anchor-links vocab: false level: error scope: raw diff --git a/doc/.vale/gitlab_docs/InternalLinkExtension.yml b/doc/.vale/gitlab_docs/InternalLinkExtension.yml index 2126029357377e7bbda8bdddb42d2df2325709bb..54aa480f0820dda06b98ddf7c6fb41226a185996 100644 --- a/doc/.vale/gitlab_docs/InternalLinkExtension.yml +++ b/doc/.vale/gitlab_docs/InternalLinkExtension.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Link to a file and use the .md file extension instead of .html." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#links vocab: false level: error scope: raw diff --git a/doc/.vale/gitlab_docs/InternalLinkFormat.yml b/doc/.vale/gitlab_docs/InternalLinkFormat.yml index c54557fa65dcce93d74366a925f0e9411061351b..058a60c44f9236253a7d60e1b07d3d67e6a79be8 100644 --- a/doc/.vale/gitlab_docs/InternalLinkFormat.yml +++ b/doc/.vale/gitlab_docs/InternalLinkFormat.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Edit the link so it does not start with '/' or './'." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#links vocab: false level: error scope: raw diff --git a/doc/.vale/gitlab_docs/InternalLinksCode.yml b/doc/.vale/gitlab_docs/InternalLinksCode.yml index d5e41e2fb35060cb14757c25239f4b3bcf6f7966..e4333c2426387bee992e5a9a8f14a80fc39f3b12 100644 --- a/doc/.vale/gitlab_docs/InternalLinksCode.yml +++ b/doc/.vale/gitlab_docs/InternalLinksCode.yml @@ -5,7 +5,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Use full URLs for files outside the docs directory." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#links vocab: false level: error scope: raw diff --git a/doc/.vale/gitlab_docs/ReferenceLinks.yml b/doc/.vale/gitlab_docs/ReferenceLinks.yml index da0e0ac376c2c09fd36815d314a261f31c6d4cb2..a4697b8e9246314dcab8362bac4289b1fc219908 100644 --- a/doc/.vale/gitlab_docs/ReferenceLinks.yml +++ b/doc/.vale/gitlab_docs/ReferenceLinks.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Put this link inline with the rest of the text." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#links vocab: false level: error nonword: true diff --git a/doc/.vale/gitlab_docs/RelativeLinks.yml b/doc/.vale/gitlab_docs/RelativeLinks.yml index 36953d9e994931b0ea2a5bb2aa35901eb409e7c5..11aaa348a4986eb7d20ca48f9ca03c62819cacad 100644 --- a/doc/.vale/gitlab_docs/RelativeLinks.yml +++ b/doc/.vale/gitlab_docs/RelativeLinks.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Use a relative link instead of a URL, and ensure the file name ends in .md and not .html." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#links vocab: false level: error scope: raw diff --git a/doc/.vale/gitlab_docs/RelativeLinksDoubleSlashes.yml b/doc/.vale/gitlab_docs/RelativeLinksDoubleSlashes.yml index 86cd86856bdb1d5c93f350b6ceb56e0994ba556e..868d3d741fa7ab6c0ae1b385ff325bc838d4ef00 100644 --- a/doc/.vale/gitlab_docs/RelativeLinksDoubleSlashes.yml +++ b/doc/.vale/gitlab_docs/RelativeLinksDoubleSlashes.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Do not use double slashes '//' or '../doc' in the link path" -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#links vocab: false level: error scope: raw diff --git a/doc/.vale/gitlab_docs/TabsLinks.yml b/doc/.vale/gitlab_docs/TabsLinks.yml index fe17de3816cb70b826a329831719d62d4fb53567..26434959a1f1c7be4c93842d420eb45b63b7b10f 100644 --- a/doc/.vale/gitlab_docs/TabsLinks.yml +++ b/doc/.vale/gitlab_docs/TabsLinks.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Do not include tabs query parameters in links." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#tabs +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#tabs vocab: false level: error scope: raw diff --git a/doc/administration/backup_restore/backup_large_reference_architectures.md b/doc/administration/backup_restore/backup_large_reference_architectures.md index d95cc625112e14f5ecca09af7a4729d97a4fdad6..d04f4b80d9bd8ba264eafccb53ded8d4f691eb96 100644 --- a/doc/administration/backup_restore/backup_large_reference_architectures.md +++ b/doc/administration/backup_restore/backup_large_reference_architectures.md @@ -300,7 +300,7 @@ new bucket. [Using a non-packaged PostgreSQL database management server](https://docs.gitlab.com/omnibus/settings/database.html#using-a-non-packaged-postgresql-database-management-server). - For Helm chart (Kubernetes) installations, follow - [Configure the GitLab chart with an external database](https://docs.gitlab.com/charts/advanced/external-db/index.html). + [Configure the GitLab chart with an external database](https://docs.gitlab.com/charts/advanced/external-db/). 1. Before moving on, wait until the new RDS instance is created and ready to use. @@ -313,7 +313,7 @@ new bucket. [Using a non-packaged PostgreSQL database management server](https://docs.gitlab.com/omnibus/settings/database.html#using-a-non-packaged-postgresql-database-management-server). - For Helm chart (Kubernetes) installations, follow - [Configure the GitLab chart with an external database](https://docs.gitlab.com/charts/advanced/external-db/index.html). + [Configure the GitLab chart with an external database](https://docs.gitlab.com/charts/advanced/external-db/). 1. Before moving on, wait until the Cloud SQL instance is ready to use. diff --git a/doc/administration/geo/_index.md b/doc/administration/geo/_index.md index c6f6c06b89965f176a7147663527b8c23ee41007..5189e1341a1d4e6fed54fa0d3e5788577f4eec7a 100644 --- a/doc/administration/geo/_index.md +++ b/doc/administration/geo/_index.md @@ -344,7 +344,7 @@ of the backfill. ### Runners -- In addition to our standard best practices for deploying a [fleet of runners](https://docs.gitlab.com/runner/fleet_scaling/index.html), runners can also be configured to connect to Geo secondaries to spread out job load. See how to [register runners against secondaries](secondary_proxy/runners.md). +- In addition to our standard best practices for deploying a [fleet of runners](https://docs.gitlab.com/runner/fleet_scaling/), runners can also be configured to connect to Geo secondaries to spread out job load. See how to [register runners against secondaries](secondary_proxy/runners.md). - See also how to handle [Disaster Recovery with runners](disaster_recovery/planned_failover.md#runner-failover). ### Upgrading Geo diff --git a/doc/administration/geo/disaster_recovery/_index.md b/doc/administration/geo/disaster_recovery/_index.md index 36d9bec56ee53e024626e90bb08dca167deb07b5..dc98052328dfd25ec7a8de295b45e4152f81abdb 100644 --- a/doc/administration/geo/disaster_recovery/_index.md +++ b/doc/administration/geo/disaster_recovery/_index.md @@ -276,9 +276,9 @@ changing Git remotes and API URLs. 1. Update the **secondary**'s SSL certificate: - - If you use the [Let's Encrypt integration](https://docs.gitlab.com/omnibus/settings/ssl/index.html#enable-the-lets-encrypt-integration), + - If you use the [Let's Encrypt integration](https://docs.gitlab.com/omnibus/settings/ssl/#enable-the-lets-encrypt-integration), the certificate updates automatically. - - If you had [manually set up](https://docs.gitlab.com/omnibus/settings/ssl/index.html#configure-https-manually), + - If you had [manually set up](https://docs.gitlab.com/omnibus/settings/ssl/#configure-https-manually), the **secondary**'s certificate, copy the certificate from the **primary** to the **secondary**. If you don't have access to the **primary**, issue a new certificate and make sure it contains both the **primary** and **secondary** URLs in the subject alternative names. You can check with: diff --git a/doc/administration/geo/replication/configuration.md b/doc/administration/geo/replication/configuration.md index 98275f8213e846a5278e22840f51acedc12c1a95..e59a1334f750e14ff820d8ba27474360e6bb4bca 100644 --- a/doc/administration/geo/replication/configuration.md +++ b/doc/administration/geo/replication/configuration.md @@ -277,12 +277,12 @@ You can safely skip this step if: ### Custom or self-signed certificate for inbound connections -If your GitLab Geo **primary** site uses a custom or [self-signed certificate to secure inbound HTTPS connections](https://docs.gitlab.com/omnibus/settings/ssl/index.html#install-custom-public-certificates), this can be either a single-domain or multi-domain certificate. +If your GitLab Geo **primary** site uses a custom or [self-signed certificate to secure inbound HTTPS connections](https://docs.gitlab.com/omnibus/settings/ssl/#install-custom-public-certificates), this can be either a single-domain or multi-domain certificate. Install the correct certificate based on your certificate type: - **Multi-domain certificate** that includes both primary and secondary site domains: Install the certificate at `/etc/gitlab/ssl` on all **Rails, Sidekiq, and Gitaly** nodes in the **secondary** site. -- **Single-domain certificate** where the certificates are specific to each Geo site domain: Generate a valid certificate for your **secondary** site's domain and install it at `/etc/gitlab/ssl` following [these instructions](https://docs.gitlab.com/omnibus/settings/ssl/index.html#install-custom-public-certificates) on all **Rails, Sidekiq, and Gitaly** nodes in the **secondary** site. +- **Single-domain certificate** where the certificates are specific to each Geo site domain: Generate a valid certificate for your **secondary** site's domain and install it at `/etc/gitlab/ssl` following [these instructions](https://docs.gitlab.com/omnibus/settings/ssl/#install-custom-public-certificates) on all **Rails, Sidekiq, and Gitaly** nodes in the **secondary** site. ### Connecting to external services that use custom certificates diff --git a/doc/administration/geo/replication/troubleshooting/common.md b/doc/administration/geo/replication/troubleshooting/common.md index 67ef17754994bb4d815be8ec8cedcd439b314467..ce96c4f22ff9a820a0f4d1563ba5d04d95a29643 100644 --- a/doc/administration/geo/replication/troubleshooting/common.md +++ b/doc/administration/geo/replication/troubleshooting/common.md @@ -437,7 +437,7 @@ Geo finds the current Puma or Sidekiq node's Geo [site](../../glossary.md) name 1. Get the "Geo node name" (there is [an issue to rename the settings to "Geo site name"](https://gitlab.com/gitlab-org/gitlab/-/issues/335944)): - Linux package: get the `gitlab_rails['geo_node_name']` setting. - - GitLab Helm charts: get the `global.geo.nodeName` setting (see [Charts with GitLab Geo](https://docs.gitlab.com/charts/advanced/geo/index.html)). + - GitLab Helm charts: get the `global.geo.nodeName` setting (see [Charts with GitLab Geo](https://docs.gitlab.com/charts/advanced/geo/)). 1. If that is not defined, then get the `external_url` setting. This name is used to look up the Geo site with the same **Name** in the **Geo Sites** diff --git a/doc/administration/geo/secondary_proxy/_index.md b/doc/administration/geo/secondary_proxy/_index.md index 43eb5d0533eb8b1891ec2e3ba3db4199ba96d2f2..54186a28885478d1e40cfc57c429c300390c2326 100644 --- a/doc/administration/geo/secondary_proxy/_index.md +++ b/doc/administration/geo/secondary_proxy/_index.md @@ -151,7 +151,7 @@ the following steps if your sites use different URLs: To allow the sites to talk to each other, [make sure the `Internal URL` field is unique for each site](../../geo_sites.md#set-up-the-internal-urls). -In Kubernetes, you can [use the same domain under `global.hosts.domain` as for the primary site](https://docs.gitlab.com/charts/advanced/geo/index.html). +In Kubernetes, you can [use the same domain under `global.hosts.domain` as for the primary site](https://docs.gitlab.com/charts/advanced/geo/). ## Set up a separate URL for a secondary Geo site diff --git a/doc/administration/gitaly/configure_gitaly.md b/doc/administration/gitaly/configure_gitaly.md index 1ec9e8391c83683702eec52b76286d09bf97823f..0288a1a230a33c8d9f90f291c2f6324346d5d42a 100644 --- a/doc/administration/gitaly/configure_gitaly.md +++ b/doc/administration/gitaly/configure_gitaly.md @@ -1315,7 +1315,7 @@ gitaly['configuration'] = { :::TabTitle Helm chart (Kubernetes) For Helm-based deployments, see the -[server-side backup documentation for Gitaly chart](https://docs.gitlab.com/charts/charts/gitlab/gitaly/index.html#server-side-backups). +[server-side backup documentation for Gitaly chart](https://docs.gitlab.com/charts/charts/gitlab/gitaly/#server-side-backups). :::TabTitle Self-compiled (source) @@ -1360,7 +1360,7 @@ gitaly['configuration'] = { :::TabTitle Helm chart (Kubernetes) For Helm-based deployments, see the -[server-side backup documentation for Gitaly chart](https://docs.gitlab.com/charts/charts/gitlab/gitaly/index.html#server-side-backups). +[server-side backup documentation for Gitaly chart](https://docs.gitlab.com/charts/charts/gitlab/gitaly/#server-side-backups). :::TabTitle Self-compiled (source) @@ -1406,7 +1406,7 @@ gitaly['configuration'] = { :::TabTitle Helm chart (Kubernetes) For Helm-based deployments, see the -[server-side backup documentation for Gitaly chart](https://docs.gitlab.com/charts/charts/gitlab/gitaly/index.html#server-side-backups). +[server-side backup documentation for Gitaly chart](https://docs.gitlab.com/charts/charts/gitlab/gitaly/#server-side-backups). :::TabTitle Self-compiled (source) @@ -1435,7 +1435,7 @@ The following parameters are supported: :::TabTitle Helm chart (Kubernetes) For Helm-based deployments, see the -[server-side backup documentation for Gitaly chart](https://docs.gitlab.com/charts/charts/gitlab/gitaly/index.html#server-side-backups). +[server-side backup documentation for Gitaly chart](https://docs.gitlab.com/charts/charts/gitlab/gitaly/#server-side-backups). :::TabTitle Linux package (Omnibus) diff --git a/doc/administration/gitaly/praefect.md b/doc/administration/gitaly/praefect.md index 03238d897f58091788a2f0c403166319b1535bd6..dabe3698cce8f538ccdccca3ade5601681efd913 100644 --- a/doc/administration/gitaly/praefect.md +++ b/doc/administration/gitaly/praefect.md @@ -733,7 +733,7 @@ for secure connections, you must: Additionally the certificate, or its certificate authority, must be installed on all Gitaly servers and on all Praefect clients that communicate with it following the procedure described in -[GitLab custom certificate configuration](https://docs.gitlab.com/omnibus/settings/ssl/index.html#install-custom-public-certificates) (and repeated below). +[GitLab custom certificate configuration](https://docs.gitlab.com/omnibus/settings/ssl/#install-custom-public-certificates) (and repeated below). Note the following: diff --git a/doc/administration/gitaly/troubleshooting.md b/doc/administration/gitaly/troubleshooting.md index e091e2efbed7e4b96dce50c40c87d174c50f5c5c..1d6949b915c4a25cb3accfd661d841cd36856659 100644 --- a/doc/administration/gitaly/troubleshooting.md +++ b/doc/administration/gitaly/troubleshooting.md @@ -105,7 +105,7 @@ check for an SSL or TLS problem: ``` Check whether `Verify return code` field indicates a -[known Linux package installation configuration problem](https://docs.gitlab.com/omnibus/settings/ssl/index.html). +[known Linux package installation configuration problem](https://docs.gitlab.com/omnibus/settings/ssl/). If `openssl` succeeds but `gitlab-rake gitlab:gitaly:check` fails, check [certificate requirements](tls_support.md#certificate-requirements) for Gitaly. diff --git a/doc/administration/integration/plantuml.md b/doc/administration/integration/plantuml.md index 5436b34609c0cd32c757af9eb2d8f9aa65f13aca..aab3255790435585e81fcc2826b03438afad712d 100644 --- a/doc/administration/integration/plantuml.md +++ b/doc/administration/integration/plantuml.md @@ -295,7 +295,7 @@ following: - `http://plantuml:8005/` - `http://localhost:8005/plantuml/` -If you're running [GitLab with TLS](https://docs.gitlab.com/omnibus/settings/ssl/index.html) +If you're running [GitLab with TLS](https://docs.gitlab.com/omnibus/settings/ssl/) you must configure this redirection, because PlantUML uses the insecure HTTP protocol. Newer browsers, such as [Google Chrome 86+](https://www.chromestatus.com/feature/4926989725073408), don't load insecure HTTP resources on pages served over HTTPS. diff --git a/doc/administration/lfs/_index.md b/doc/administration/lfs/_index.md index a369d63267ae215453f8bc843085caae00068800..ed87ce8311a1bdcabfaac8ef6ceb6b46045ca769 100644 --- a/doc/administration/lfs/_index.md +++ b/doc/administration/lfs/_index.md @@ -520,7 +520,7 @@ error: failed to fetch some objects from 'https://username:[MASKED]@gitlab.examp ``` When using GitLab CI over a TLS v1.3 configured GitLab server, you must -[upgrade to GitLab Runner](https://docs.gitlab.com/runner/install/index.html) 13.2.0 +[upgrade to GitLab Runner](https://docs.gitlab.com/runner/install/) 13.2.0 or later to receive an updated Git LFS client version with the included [GitLab Runner Helper image](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#helper-image). diff --git a/doc/administration/load_balancer.md b/doc/administration/load_balancer.md index ae3fcb7ae014d4173a1f55b06bdacbc8a40e95f6..7f67a134c8e1e3c2f7794ff494debe9ffa6f762a 100644 --- a/doc/administration/load_balancer.md +++ b/doc/administration/load_balancer.md @@ -34,7 +34,7 @@ Configure your load balancers to pass connections on port 443 as 'TCP' rather than 'HTTP(S)' protocol. This passes the connection to the application nodes NGINX service untouched. NGINX has the SSL certificate and listen on port 443. -See the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html) +See the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/) for details on managing SSL certificates and configuring NGINX. ### Load Balancers terminate SSL without backend SSL @@ -45,7 +45,7 @@ terminating SSL. Because communication between the load balancers and GitLab isn't secure, there is some additional configuration needed. See the -[proxied SSL documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html#configure-a-reverse-proxy-or-load-balancer-ssl-termination) +[proxied SSL documentation](https://docs.gitlab.com/omnibus/settings/ssl/#configure-a-reverse-proxy-or-load-balancer-ssl-termination) for details. ### Load Balancers terminate SSL with backend SSL @@ -58,7 +58,7 @@ Traffic is secure between the load balancers and NGINX in this scenario. There is no need to add configuration for proxied SSL because the connection is secure all the way. However, configuration must be added to GitLab to configure SSL certificates. See -the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html) +the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/) for details on managing SSL certificates and configuring NGINX. ## Ports @@ -134,7 +134,7 @@ The default ciphers for a GitLab version can be viewed in the [`files/gitlab-cookbooks/gitlab/attributes/default.rb`](https://gitlab.com/gitlab-org/omnibus-gitlab/-/blob/master/files/gitlab-cookbooks/gitlab/attributes/default.rb) file and selecting the Git tag that correlates with your target GitLab version (for example `15.0.5+ee.0`). If required by your load balancer, you can then define -[custom SSL ciphers](https://docs.gitlab.com/omnibus/settings/ssl/index.html#use-custom-ssl-ciphers) +[custom SSL ciphers](https://docs.gitlab.com/omnibus/settings/ssl/#use-custom-ssl-ciphers) for NGINX. ### Some pages and links are downloaded instead of rendered in the browser diff --git a/doc/administration/operations/gitlab_sshd.md b/doc/administration/operations/gitlab_sshd.md index 7b4fbff93d069f8f31cbdcfd48ba2fb0adf4cf81..37043ff73e249e955b4b17c9d62f843e84cd74c3 100644 --- a/doc/administration/operations/gitlab_sshd.md +++ b/doc/administration/operations/gitlab_sshd.md @@ -81,7 +81,7 @@ generation and copy the existing OpenSSH host keys into The following instructions switch OpenSSH in favor of `gitlab-sshd`: 1. Set the `gitlab-shell` charts `sshDaemon` option to - [`gitlab-sshd`](https://docs.gitlab.com/charts/charts/gitlab/gitlab-shell/index.html#installation-command-line-options). + [`gitlab-sshd`](https://docs.gitlab.com/charts/charts/gitlab/gitlab-shell/#installation-command-line-options). For example: ```yaml @@ -133,7 +133,7 @@ To enable the PROXY protocol: :::TabTitle Helm chart (Kubernetes) -1. Set the [`gitlab.gitlab-shell.config` options](https://docs.gitlab.com/charts/charts/gitlab/gitlab-shell/index.html#installation-command-line-options). For example: +1. Set the [`gitlab.gitlab-shell.config` options](https://docs.gitlab.com/charts/charts/gitlab/gitlab-shell/#installation-command-line-options). For example: ```yaml gitlab: diff --git a/doc/administration/operations/puma.md b/doc/administration/operations/puma.md index 42374c2609ef6ffb085a2de2b917d620622a43bc..88e12413cf2c00912faca1390aed8a5c1f056536 100644 --- a/doc/administration/operations/puma.md +++ b/doc/administration/operations/puma.md @@ -154,7 +154,7 @@ steps below: NOTE: If using a self-signed certificate from a custom Certificate Authority (CA), - follow [the documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html#install-custom-public-certificates) + follow [the documentation](https://docs.gitlab.com/omnibus/settings/ssl/#install-custom-public-certificates) to make them trusted by other GitLab components. 1. Edit `/etc/gitlab/gitlab.rb`: @@ -251,7 +251,7 @@ configure this: NOTE: For Helm-based deployments, see the -[`webservice` chart documentation](https://docs.gitlab.com/charts/charts/gitlab/webservice/index.html). +[`webservice` chart documentation](https://docs.gitlab.com/charts/charts/gitlab/webservice/). Puma is the default web server and Unicorn is no longer supported. diff --git a/doc/administration/packages/container_registry.md b/doc/administration/packages/container_registry.md index abbb49660da2281e878fb67f9afc08a2c572d4a2..f981a53652758bfede9b42c67ce3dc08d6f1c378 100644 --- a/doc/administration/packages/container_registry.md +++ b/doc/administration/packages/container_registry.md @@ -37,7 +37,7 @@ If you installed GitLab by using the Linux package, the container registry may or may not be available by default. The container registry is automatically enabled and available on your GitLab domain, port 5050 if -you're using the built-in [Let's Encrypt integration](https://docs.gitlab.com/omnibus/settings/ssl/index.html#enable-the-lets-encrypt-integration). +you're using the built-in [Let's Encrypt integration](https://docs.gitlab.com/omnibus/settings/ssl/#enable-the-lets-encrypt-integration). Otherwise, the container registry is not enabled. To enable it: @@ -224,7 +224,7 @@ domain. For example, `*.gitlab.example.com`, is a wildcard that matches `registr and is distinct from `*.example.com`. As well as manually generated SSL certificates (explained here), certificates automatically -generated by Let's Encrypt are also [supported in Linux package installations](https://docs.gitlab.com/omnibus/settings/ssl/index.html). +generated by Let's Encrypt are also [supported in Linux package installations](https://docs.gitlab.com/omnibus/settings/ssl/). Let's assume that you want the container registry to be accessible at `https://registry.gitlab.example.com`. diff --git a/doc/administration/pages/_index.md b/doc/administration/pages/_index.md index f8e8fad9f29c20714b0bc3a3ae053340e9a0b90d..44666fdae752d5c271449fcc04a6b5713b35a3e6 100644 --- a/doc/administration/pages/_index.md +++ b/doc/administration/pages/_index.md @@ -677,7 +677,7 @@ fails to work if the custom CA is not recognized. This usually results in this error: `Post /oauth/token: x509: certificate signed by unknown authority`. -For Linux package installations, this is fixed by [installing a custom CA](https://docs.gitlab.com/omnibus/settings/ssl/index.html#install-custom-public-certificates). +For Linux package installations, this is fixed by [installing a custom CA](https://docs.gitlab.com/omnibus/settings/ssl/#install-custom-public-certificates). For self-compiled installations, this can be fixed by installing the custom Certificate Authority (CA) in the system certificate store. @@ -1259,7 +1259,7 @@ To allow certain IP ranges (subnets) to bypass all rate limits: - `rate_limit_subnets_allow_list`: Sets the allow list with the IP ranges (subnets) that should bypass all rate limits. For example, `['1.2.3.4/24', '2001:db8::1/32']`. - [Charts example](https://docs.gitlab.com/charts/charts/gitlab/gitlab-pages/index.html#configure-rate-limits-subnets-allow-list) is available. + [Charts example](https://docs.gitlab.com/charts/charts/gitlab/gitlab-pages/#configure-rate-limits-subnets-allow-list) is available. An IPv6 address receives a large prefix in the 128-bit address space. The prefix is typically at least size /64. Because of the large number of possible addresses, if the client's IP address is IPv6, the limit is applied to the IPv6 prefix with a length of 64, rather than the entire IPv6 address. diff --git a/doc/administration/raketasks/maintenance.md b/doc/administration/raketasks/maintenance.md index c8b219c985e929bd3d14c4ff4a43eb9f6db7a9f5..bee047129eee37f87d288c21b7b88a1bdbbadef7 100644 --- a/doc/administration/raketasks/maintenance.md +++ b/doc/administration/raketasks/maintenance.md @@ -131,7 +131,7 @@ component servers like [Gitaly](../gitaly/configure_gitaly.md#run-gitaly-on-its- You may also have a look at our troubleshooting guides for: - [GitLab](../troubleshooting/_index.md). -- [Linux package installations](https://docs.gitlab.com/omnibus/index.html#troubleshooting). +- [Linux package installations](https://docs.gitlab.com/omnibus/#troubleshooting). Additionally you should also [verify database values can be decrypted using the current secrets](check.md#verify-database-values-can-be-decrypted-using-the-current-secrets). diff --git a/doc/administration/reference_architectures/10k_users.md b/doc/administration/reference_architectures/10k_users.md index bbc5a9e54b5745964d51524c373617c8d9ad90c5..2609521a3ae454c894843767c6c2c6e2b36f7c19 100644 --- a/doc/administration/reference_architectures/10k_users.md +++ b/doc/administration/reference_architectures/10k_users.md @@ -326,7 +326,7 @@ Configure your load balancer to pass connections on port 443 as `TCP` rather than `HTTP(S)` protocol. This will pass the connection to the application node's NGINX service untouched. NGINX will have the SSL certificate and listen on port 443. -See the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html) +See the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/) for details on managing SSL certificates and configuring NGINX. #### Load balancer terminates SSL without backend SSL @@ -337,7 +337,7 @@ terminating SSL. Since communication between the load balancer and GitLab will not be secure, there is some additional configuration needed. See the -[proxied SSL documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html#configure-a-reverse-proxy-or-load-balancer-ssl-termination) +[proxied SSL documentation](https://docs.gitlab.com/omnibus/settings/ssl/#configure-a-reverse-proxy-or-load-balancer-ssl-termination) for details. #### Load balancer terminates SSL with backend SSL @@ -350,7 +350,7 @@ Traffic will also be secure between the load balancers and NGINX in this scenario. There is no need to add configuration for proxied SSL since the connection will be secure all the way. However, configuration will need to be added to GitLab to configure SSL certificates. See -the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html) +the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/) for details on managing SSL certificates and configuring NGINX. <div align="right"> @@ -1681,7 +1681,7 @@ for secure connections, you must: Additionally the certificate, or its certificate authority, must be installed on all Gitaly servers and on all Praefect clients that communicate with it following the procedure described in -[GitLab custom certificate configuration](https://docs.gitlab.com/omnibus/settings/ssl/index.html#install-custom-public-certificates) (and repeated below). +[GitLab custom certificate configuration](https://docs.gitlab.com/omnibus/settings/ssl/#install-custom-public-certificates) (and repeated below). Note the following: @@ -2094,7 +2094,7 @@ On each node perform the following: When you specify `https` in the `external_url`, as in the previous example, GitLab expects that the SSL certificates are in `/etc/gitlab/ssl/`. If the certificates aren't present, NGINX will fail to start. For more information, see -the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html). +the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/). ### GitLab Rails post-configuration diff --git a/doc/administration/reference_architectures/25k_users.md b/doc/administration/reference_architectures/25k_users.md index 872938a1f6fa86c59f3b67bbffb08aaf5cbad0c0..f1e22e8a623b5860cb8b46abc7cdc95fb3cd559b 100644 --- a/doc/administration/reference_architectures/25k_users.md +++ b/doc/administration/reference_architectures/25k_users.md @@ -328,7 +328,7 @@ Configure your load balancer to pass connections on port 443 as `TCP` rather than `HTTP(S)` protocol. This will pass the connection to the application node's NGINX service untouched. NGINX will have the SSL certificate and listen on port 443. -See the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html) +See the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/) for details on managing SSL certificates and configuring NGINX. #### Load balancer terminates SSL without backend SSL @@ -339,7 +339,7 @@ terminating SSL. Since communication between the load balancer and GitLab will not be secure, there is some additional configuration needed. See the -[proxied SSL documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html#configure-a-reverse-proxy-or-load-balancer-ssl-termination) +[proxied SSL documentation](https://docs.gitlab.com/omnibus/settings/ssl/#configure-a-reverse-proxy-or-load-balancer-ssl-termination) for details. #### Load balancer terminates SSL with backend SSL @@ -352,7 +352,7 @@ Traffic will also be secure between the load balancers and NGINX in this scenario. There is no need to add configuration for proxied SSL since the connection will be secure all the way. However, configuration will need to be added to GitLab to configure SSL certificates. See -the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html) +the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/) for details on managing SSL certificates and configuring NGINX. <div align="right"> @@ -1687,7 +1687,7 @@ for secure connections, you must: Additionally the certificate, or its certificate authority, must be installed on all Gitaly servers and on all Praefect clients that communicate with it following the procedure described in -[GitLab custom certificate configuration](https://docs.gitlab.com/omnibus/settings/ssl/index.html#install-custom-public-certificates) (and repeated below). +[GitLab custom certificate configuration](https://docs.gitlab.com/omnibus/settings/ssl/#install-custom-public-certificates) (and repeated below). Note the following: @@ -2102,7 +2102,7 @@ On each node perform the following: When you specify `https` in the `external_url`, as in the previous example, GitLab expects that the SSL certificates are in `/etc/gitlab/ssl/`. If the certificates aren't present, NGINX will fail to start. For more information, see -the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html). +the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/). ### GitLab Rails post-configuration diff --git a/doc/administration/reference_architectures/2k_users.md b/doc/administration/reference_architectures/2k_users.md index e7dda045cc4d619feb328848930eac9678ffffaa..ab2e0ae6aa5124c92e11f0f756f25f9f7c5540c7 100644 --- a/doc/administration/reference_architectures/2k_users.md +++ b/doc/administration/reference_architectures/2k_users.md @@ -227,7 +227,7 @@ Configure your load balancer to pass connections on port 443 as `TCP` rather than `HTTP(S)` protocol. This will pass the connection to the application node's NGINX service untouched. NGINX will have the SSL certificate and listen on port 443. -See the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html) +See the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/) for details on managing SSL certificates and configuring NGINX. #### Load balancer terminates SSL without backend SSL @@ -238,7 +238,7 @@ terminating SSL. Since communication between the load balancer and GitLab will not be secure, there is some additional configuration needed. See the -[proxied SSL documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html#configure-a-reverse-proxy-or-load-balancer-ssl-termination) +[proxied SSL documentation](https://docs.gitlab.com/omnibus/settings/ssl/#configure-a-reverse-proxy-or-load-balancer-ssl-termination) for details. #### Load balancer terminates SSL with backend SSL @@ -251,7 +251,7 @@ Traffic will also be secure between the load balancers and NGINX in this scenario. There is no need to add configuration for proxied SSL since the connection will be secure all the way. However, configuration will need to be added to GitLab to configure SSL certificates. See -the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html) +the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/) for details on managing SSL certificates and configuring NGINX. <div align="right"> @@ -558,7 +558,7 @@ You must bring your own certificates as this isn't provided automatically. The certificate, or its certificate authority, must be installed on all Gitaly nodes (including the Gitaly node using the certificate) and on all client nodes that communicate with it following the procedure described in -[GitLab custom certificate configuration](https://docs.gitlab.com/omnibus/settings/ssl/index.html#install-custom-public-certificates). +[GitLab custom certificate configuration](https://docs.gitlab.com/omnibus/settings/ssl/#install-custom-public-certificates). NOTE: The self-signed certificate must specify the address you use to access the @@ -910,7 +910,7 @@ On each node perform the following: When you specify `https` in the `external_url`, as in the previous example, GitLab expects that the SSL certificates are in `/etc/gitlab/ssl/`. If the certificates aren't present, NGINX will fail to start. For more information, see -the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html). +the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/). ### GitLab Rails post-configuration diff --git a/doc/administration/reference_architectures/3k_users.md b/doc/administration/reference_architectures/3k_users.md index 5e21086a291b100b1169299c84b4d4a3b6ebbd99..8c7ab80305265176d35c4a28cd4a1ec972b001d6 100644 --- a/doc/administration/reference_architectures/3k_users.md +++ b/doc/administration/reference_architectures/3k_users.md @@ -316,7 +316,7 @@ Configure your load balancer to pass connections on port 443 as `TCP` rather than `HTTP(S)` protocol. This will pass the connection to the application node's NGINX service untouched. NGINX will have the SSL certificate and listen on port 443. -See the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html) +See the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/) for details on managing SSL certificates and configuring NGINX. #### Load balancer terminates SSL without backend SSL @@ -327,7 +327,7 @@ terminating SSL. Since communication between the load balancer and GitLab will not be secure, there is some additional configuration needed. See the -[proxied SSL documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html#configure-a-reverse-proxy-or-load-balancer-ssl-termination) +[proxied SSL documentation](https://docs.gitlab.com/omnibus/settings/ssl/#configure-a-reverse-proxy-or-load-balancer-ssl-termination) for details. #### Load balancer terminates SSL with backend SSL @@ -340,7 +340,7 @@ Traffic will also be secure between the load balancers and NGINX in this scenario. There is no need to add configuration for proxied SSL since the connection will be secure all the way. However, configuration will need to be added to GitLab to configure SSL certificates. See -the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html) +the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/) for details on managing SSL certificates and configuring NGINX. <div align="right"> @@ -1521,7 +1521,7 @@ for secure connections, you must: Additionally the certificate, or its certificate authority, must be installed on all Gitaly servers and on all Praefect clients that communicate with it following the procedure described in -[GitLab custom certificate configuration](https://docs.gitlab.com/omnibus/settings/ssl/index.html#install-custom-public-certificates) (and repeated below). +[GitLab custom certificate configuration](https://docs.gitlab.com/omnibus/settings/ssl/#install-custom-public-certificates) (and repeated below). Note the following: @@ -1962,7 +1962,7 @@ On each node perform the following: When you specify `https` in the `external_url`, as in the previous example, GitLab expects that the SSL certificates are in `/etc/gitlab/ssl/`. If the certificates aren't present, NGINX will fail to start. For more information, see -the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html). +the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/). ### GitLab Rails post-configuration diff --git a/doc/administration/reference_architectures/50k_users.md b/doc/administration/reference_architectures/50k_users.md index 8c3665b8a8fac11a4cf5876033067aaf23957a44..bf71fae30fcb6ed80bbee75e3ab0366ddeba6a24 100644 --- a/doc/administration/reference_architectures/50k_users.md +++ b/doc/administration/reference_architectures/50k_users.md @@ -334,7 +334,7 @@ Configure your load balancer to pass connections on port 443 as `TCP` rather than `HTTP(S)` protocol. This will pass the connection to the application node's NGINX service untouched. NGINX will have the SSL certificate and listen on port 443. -See the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html) +See the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/) for details on managing SSL certificates and configuring NGINX. #### Load balancer terminates SSL without backend SSL @@ -345,7 +345,7 @@ terminating SSL. Since communication between the load balancer and GitLab will not be secure, there is some additional configuration needed. See the -[proxied SSL documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html#configure-a-reverse-proxy-or-load-balancer-ssl-termination) +[proxied SSL documentation](https://docs.gitlab.com/omnibus/settings/ssl/#configure-a-reverse-proxy-or-load-balancer-ssl-termination) for details. #### Load balancer terminates SSL with backend SSL @@ -358,7 +358,7 @@ Traffic will also be secure between the load balancers and NGINX in this scenario. There is no need to add configuration for proxied SSL since the connection will be secure all the way. However, configuration will need to be added to GitLab to configure SSL certificates. See -the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html) +the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/) for details on managing SSL certificates and configuring NGINX. <div align="right"> @@ -1694,7 +1694,7 @@ for secure connections, you must: Additionally the certificate, or its certificate authority, must be installed on all Gitaly servers and on all Praefect clients that communicate with it following the procedure described in -[GitLab custom certificate configuration](https://docs.gitlab.com/omnibus/settings/ssl/index.html#install-custom-public-certificates) (and repeated below). +[GitLab custom certificate configuration](https://docs.gitlab.com/omnibus/settings/ssl/#install-custom-public-certificates) (and repeated below). Note the following: @@ -2117,7 +2117,7 @@ On each node perform the following: When you specify `https` in the `external_url`, as in the previous example, GitLab expects that the SSL certificates are in `/etc/gitlab/ssl/`. If the certificates aren't present, NGINX will fail to start. For more information, see -the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html). +the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/). ### GitLab Rails post-configuration diff --git a/doc/administration/reference_architectures/5k_users.md b/doc/administration/reference_architectures/5k_users.md index 1ab4e4151faa55b8e30b1984cadacad39cba7e85..99d6f7cab4a9504e01faedc169e1eb8cb9691579 100644 --- a/doc/administration/reference_architectures/5k_users.md +++ b/doc/administration/reference_architectures/5k_users.md @@ -316,7 +316,7 @@ Configure your load balancer to pass connections on port 443 as `TCP` rather than `HTTP(S)` protocol. This will pass the connection to the application node's NGINX service untouched. NGINX will have the SSL certificate and listen on port 443. -See the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html) +See the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/) for details on managing SSL certificates and configuring NGINX. #### Load balancer terminates SSL without backend SSL @@ -327,7 +327,7 @@ terminating SSL. Since communication between the load balancer and GitLab will not be secure, there is some additional configuration needed. See the -[proxied SSL documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html#configure-a-reverse-proxy-or-load-balancer-ssl-termination) +[proxied SSL documentation](https://docs.gitlab.com/omnibus/settings/ssl/#configure-a-reverse-proxy-or-load-balancer-ssl-termination) for details. #### Load balancer terminates SSL with backend SSL @@ -340,7 +340,7 @@ Traffic will also be secure between the load balancers and NGINX in this scenario. There is no need to add configuration for proxied SSL since the connection will be secure all the way. However, configuration will need to be added to GitLab to configure SSL certificates. See -the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html) +the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/) for details on managing SSL certificates and configuring NGINX. <div align="right"> @@ -1518,7 +1518,7 @@ for secure connections, you must: Additionally the certificate, or its certificate authority, must be installed on all Gitaly servers and on all Praefect clients that communicate with it following the procedure described in -[GitLab custom certificate configuration](https://docs.gitlab.com/omnibus/settings/ssl/index.html#install-custom-public-certificates) (and repeated below). +[GitLab custom certificate configuration](https://docs.gitlab.com/omnibus/settings/ssl/#install-custom-public-certificates) (and repeated below). Note the following: @@ -1962,7 +1962,7 @@ On each node perform the following: When you specify `https` in the `external_url`, as in the previous example, GitLab expects that the SSL certificates are in `/etc/gitlab/ssl/`. If the certificates aren't present, NGINX fails to start. For more information, see -the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html). +the [HTTPS documentation](https://docs.gitlab.com/omnibus/settings/ssl/). ### GitLab Rails post-configuration diff --git a/doc/administration/settings/external_authorization.md b/doc/administration/settings/external_authorization.md index 99a3d0f5be360071635777f329b75b0d4b5d4701..252be07a76b7bd39526a4b22366db504613f9d3d 100644 --- a/doc/administration/settings/external_authorization.md +++ b/doc/administration/settings/external_authorization.md @@ -40,7 +40,7 @@ the [Linux package documentation](https://docs.gitlab.com/omnibus/settings/logs. When using TLS Authentication with a self signed certificate, the CA certificate needs to be trusted by the OpenSSL installation. When using GitLab installed using the Linux package, learn to install a custom CA in the -[Linux package documentation](https://docs.gitlab.com/omnibus/settings/ssl/index.html). +[Linux package documentation](https://docs.gitlab.com/omnibus/settings/ssl/). Alternatively, learn where to install custom certificates by using `openssl version -d`. diff --git a/doc/api/openapi/openapi.yaml b/doc/api/openapi/openapi.yaml index 900ec55a4a3af52a823a6e74d99c898f2d97f531..3baace5e5b9e8f1721b3e253f3253c14472006f6 100644 --- a/doc/api/openapi/openapi.yaml +++ b/doc/api/openapi/openapi.yaml @@ -10,7 +10,7 @@ info: When viewing this on gitlab.com, you can test API calls directly from the browser against the `gitlab.com` instance, if you are logged in. - The feature uses the current [GitLab session cookie](https://docs.gitlab.com/ee/api/index.html#session-cookie), + The feature uses the current [GitLab session cookie](https://docs.gitlab.com/ee/api/#session-cookie), so each request is made using your account. Instructions for using this tool can be found in [Interactive API Documentation](https://docs.gitlab.com/ee/api/openapi/openapi_interactive.html) diff --git a/doc/api/openapi/openapi_interactive.md b/doc/api/openapi/openapi_interactive.md index 71d87f91da31f3b87f07d59a956adb396dd154e0..e1c1ca59ec8589186fee5842519b7021e0a5da11 100644 --- a/doc/api/openapi/openapi_interactive.md +++ b/doc/api/openapi/openapi_interactive.md @@ -19,7 +19,7 @@ For general information about the GitLab APIs, see [API Docs](../_index.md). <!-- The following link is absolute rather than relative because it needs to be viewed through the GitLab -Open API file viewer: https://docs.gitlab.com/ee/user/project/repository/index.html#openapi-viewer. +Open API file viewer: https://docs.gitlab.com/ee/user/project/repository/#openapi-viewer. --> The [interactive API documentation tool](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/openapi/openapi.yaml) allows API testing directly on the GitLab.com website. Only a few of the available endpoints are diff --git a/doc/api/templates/gitlab_ci_ymls.md b/doc/api/templates/gitlab_ci_ymls.md index 83ab49edc29f8dfea10516b3f1027a1c53a80bb3..3e5d359c769b646bc992a96a6a5efbf581878264 100644 --- a/doc/api/templates/gitlab_ci_ymls.md +++ b/doc/api/templates/gitlab_ci_ymls.md @@ -139,7 +139,7 @@ Example response: ```json { "name": "Ruby", - "content": "# This file is a template, and might need editing before it works on your project.\n# To contribute improvements to CI/CD templates, please follow the Development guide at:\n# https://docs.gitlab.com/ee/development/cicd/templates.html\n# This specific template is located at:\n# https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Ruby.gitlab-ci.yml\n\n# Official language image. Look for the different tagged releases at:\n# https://hub.docker.com/r/library/ruby/tags/\nimage: ruby:latest\n\n# Pick zero or more services to be used on all builds.\n# Only needed when using a docker container to run your tests in.\n# Check out: https://docs.gitlab.com/ee/ci/services/index.html\nservices:\n - mysql:latest\n - redis:latest\n - postgres:latest\n\nvariables:\n POSTGRES_DB: database_name\n\n# Cache gems in between builds\ncache:\n paths:\n - vendor/ruby\n\n# This is a basic example for a gem or script which doesn't use\n# services such as redis or postgres\nbefore_script:\n - ruby -v # Print out ruby version for debugging\n # Uncomment next line if your rails app needs a JS runtime:\n # - apt-get update -q \u0026\u0026 apt-get install nodejs -yqq\n - bundle config set --local deployment true # Install dependencies into ./vendor/ruby\n - bundle install -j $(nproc)\n\n# Optional - Delete if not using `rubocop`\nrubocop:\n script:\n - rubocop\n\nrspec:\n script:\n - rspec spec\n\nrails:\n variables:\n DATABASE_URL: \"postgresql://postgres:postgres@postgres:5432/$POSTGRES_DB\"\n script:\n - rails db:migrate\n - rails db:seed\n - rails test\n\n# This deploy job uses a simple deploy flow to Heroku, other providers, for example, AWS Elastic Beanstalk\n# are supported too: https://github.com/travis-ci/dpl\ndeploy:\n stage: deploy\n environment: production\n script:\n - gem install dpl\n - dpl --provider=heroku --app=$HEROKU_APP_NAME --api-key=$HEROKU_PRODUCTION_KEY\n" + "content": "# This file is a template, and might need editing before it works on your project.\n# To contribute improvements to CI/CD templates, please follow the Development guide at:\n# https://docs.gitlab.com/ee/development/cicd/templates.html\n# This specific template is located at:\n# https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Ruby.gitlab-ci.yml\n\n# Official language image. Look for the different tagged releases at:\n# https://hub.docker.com/r/library/ruby/tags/\nimage: ruby:latest\n\n# Pick zero or more services to be used on all builds.\n# Only needed when using a docker container to run your tests in.\n# Check out: https://docs.gitlab.com/ee/ci/services/\nservices:\n - mysql:latest\n - redis:latest\n - postgres:latest\n\nvariables:\n POSTGRES_DB: database_name\n\n# Cache gems in between builds\ncache:\n paths:\n - vendor/ruby\n\n# This is a basic example for a gem or script which doesn't use\n# services such as redis or postgres\nbefore_script:\n - ruby -v # Print out ruby version for debugging\n # Uncomment next line if your rails app needs a JS runtime:\n # - apt-get update -q \u0026\u0026 apt-get install nodejs -yqq\n - bundle config set --local deployment true # Install dependencies into ./vendor/ruby\n - bundle install -j $(nproc)\n\n# Optional - Delete if not using `rubocop`\nrubocop:\n script:\n - rubocop\n\nrspec:\n script:\n - rspec spec\n\nrails:\n variables:\n DATABASE_URL: \"postgresql://postgres:postgres@postgres:5432/$POSTGRES_DB\"\n script:\n - rails db:migrate\n - rails db:seed\n - rails test\n\n# This deploy job uses a simple deploy flow to Heroku, other providers, for example, AWS Elastic Beanstalk\n# are supported too: https://github.com/travis-ci/dpl\ndeploy:\n stage: deploy\n environment: production\n script:\n - gem install dpl\n - dpl --provider=heroku --app=$HEROKU_APP_NAME --api-key=$HEROKU_PRODUCTION_KEY\n" } ``` diff --git a/doc/ci/docker/authenticate_registry.md b/doc/ci/docker/authenticate_registry.md index c26d2a6b6a416379ff36e8de79a1d6cb4959d7f5..583357b88728d0bfc6c52d9549cc9cffac17ea3b 100644 --- a/doc/ci/docker/authenticate_registry.md +++ b/doc/ci/docker/authenticate_registry.md @@ -90,7 +90,7 @@ of this file. You can do this with a command like: kubectl create configmap docker-client-config --namespace gitlab-runner --from-file /opt/.docker/config.json ``` -Update the [volume mounts](https://docs.gitlab.com/runner/executors/kubernetes/index.html#custom-volume-mount) +Update the [volume mounts](https://docs.gitlab.com/runner/executors/kubernetes/#custom-volume-mount) to include the file. ```toml diff --git a/doc/ci/docker/using_docker_build.md b/doc/ci/docker/using_docker_build.md index 0a569193ada89c3008df7b6b41598379b1beec0d..bca891dbd9e791667ec74a4de098781969614be5 100644 --- a/doc/ci/docker/using_docker_build.md +++ b/doc/ci/docker/using_docker_build.md @@ -83,7 +83,7 @@ For more information, see [security of the `docker` group](https://blog.zopyx.co "Docker-in-Docker" (`dind`) means: - Your registered runner uses the [Docker executor](https://docs.gitlab.com/runner/executors/docker.html) or - the [Kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes/index.html). + the [Kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes/). - The executor uses a [container image of Docker](https://hub.docker.com/_/docker/), provided by Docker, to run your CI/CD jobs. @@ -296,7 +296,7 @@ For more information, see [Proxy settings when using dind service](https://docs. #### Use the Kubernetes executor with Docker-in-Docker -You can use the [Kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes/index.html) to run jobs in a Docker container. +You can use the [Kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes/) to run jobs in a Docker container. ##### Docker-in-Docker with TLS enabled in Kubernetes @@ -519,7 +519,7 @@ services: If you are a GitLab Runner administrator, you can specify the `command` to configure the registry mirror for the Docker daemon. The `dind` service must be defined for the [Docker](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersdockerservices-section) -or [Kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes/index.html#define-a-list-of-services). +or [Kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes/#define-a-list-of-services). Docker: @@ -587,7 +587,7 @@ detected by the `dind` service. If you are a GitLab Runner administrator, you can use the mirror for every `dind` service. Update the [configuration](https://docs.gitlab.com/runner/configuration/advanced-configuration.html) -to specify a [ConfigMap volume mount](https://docs.gitlab.com/runner/executors/kubernetes/index.html#configmap-volume). +to specify a [ConfigMap volume mount](https://docs.gitlab.com/runner/executors/kubernetes/#configmap-volume). For example, if you have a `/tmp/daemon.json` file with the following content: @@ -743,7 +743,7 @@ use one of these alternatives: To use Buildah with GitLab CI/CD, you need [a runner](https://docs.gitlab.com/runner/) with one of the following executors: -- [Kubernetes](https://docs.gitlab.com/runner/executors/kubernetes/index.html). +- [Kubernetes](https://docs.gitlab.com/runner/executors/kubernetes/). - [Docker](https://docs.gitlab.com/runner/executors/docker.html). - [Docker Machine](https://docs.gitlab.com/runner/executors/docker_machine.html). @@ -807,7 +807,7 @@ This error occurs because Docker starts on TLS automatically. - If you are upgrading from v18.09 or earlier, see the [upgrade guide](https://about.gitlab.com/blog/2019/07/31/docker-in-docker-with-docker-19-dot-03/). -This error can also occur with the [Kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes/index.html#using-dockerdind) when attempts are made to access the Docker-in-Docker service before it has fully started up. For a more detailed explanation, see [issue 27215](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/27215). +This error can also occur with the [Kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes/#using-dockerdind) when attempts are made to access the Docker-in-Docker service before it has fully started up. For a more detailed explanation, see [issue 27215](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/27215). ### Docker `no such host` error diff --git a/doc/ci/docker/using_docker_images.md b/doc/ci/docker/using_docker_images.md index 518df3a40aa1253a5c7e33954feaf183ae9ba5d7..df9a01a4d4f4a8ac7f9535007335752a6a29f5b6 100644 --- a/doc/ci/docker/using_docker_images.md +++ b/doc/ci/docker/using_docker_images.md @@ -231,7 +231,7 @@ To define which option should be used, the runner process reads the configuratio ### Requirements and limitations -- Available for [Kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes/index.html) +- Available for [Kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes/) in GitLab Runner 13.1 and later. - [Credentials Store](#use-a-credentials-store) and [Credential Helpers](#use-credential-helpers) require binaries to be added to the GitLab Runner `$PATH`, and require access to do so. Therefore, @@ -560,4 +560,4 @@ and manual credential management. - Dockerfile ``` -1. [Register the runner](https://docs.gitlab.com/runner/register/index.html#docker). +1. [Register the runner](https://docs.gitlab.com/runner/register/#docker). diff --git a/doc/ci/docker/using_kaniko.md b/doc/ci/docker/using_kaniko.md index 3314b655561b32af2194bd2138277e64623aeaae..d2ce25f1817ec373a281e719dbaaf1e376592b42 100644 --- a/doc/ci/docker/using_kaniko.md +++ b/doc/ci/docker/using_kaniko.md @@ -25,7 +25,7 @@ method: To use kaniko with GitLab, [a runner](https://docs.gitlab.com/runner/) with one of the following executors is required: -- [Kubernetes](https://docs.gitlab.com/runner/executors/kubernetes/index.html). +- [Kubernetes](https://docs.gitlab.com/runner/executors/kubernetes/). - [Docker](https://docs.gitlab.com/runner/executors/docker.html). - [Docker Machine](https://docs.gitlab.com/runner/executors/docker_machine.html). @@ -146,7 +146,7 @@ video is a walkthrough of the [Kaniko Docker Build](https://gitlab.com/guided-ex Guided Exploration project pipeline. It was tested on: - [GitLab.com instance runners](../runners/_index.md) -- [The Kubernetes runner executor](https://docs.gitlab.com/runner/executors/kubernetes/index.html) +- [The Kubernetes runner executor](https://docs.gitlab.com/runner/executors/kubernetes/) The example can be copied to your own group or instance for testing. More details on what other GitLab CI patterns are demonstrated are available at the project page. diff --git a/doc/ci/migration/bamboo.md b/doc/ci/migration/bamboo.md index c7f8ca9fa6fc279231137b815bfdc56b8a4ac44a..841a884e087dc31d396469c2af540a73421fae0e 100644 --- a/doc/ci/migration/bamboo.md +++ b/doc/ci/migration/bamboo.md @@ -46,7 +46,7 @@ GitLab uses a similar concept to agents called [runners](https://docs.gitlab.com which use [executors](https://docs.gitlab.com/runner/executors/) to run builds. Examples of executors are shell, Docker, or Kubernetes. You can choose to use [GitLab.com runners](../runners/_index.md) -or deploy your own [self-managed runners](https://docs.gitlab.com/runner/install/index.html). +or deploy your own [self-managed runners](https://docs.gitlab.com/runner/install/). ### Workflow diff --git a/doc/ci/runners/configure_runners.md b/doc/ci/runners/configure_runners.md index 8ae47f76d293d0bdd720a5d66db361b47d1f8248..ee50c83a77b0760bf523271072067cbf44ec4ef4 100644 --- a/doc/ci/runners/configure_runners.md +++ b/doc/ci/runners/configure_runners.md @@ -472,7 +472,7 @@ You can also use variables to configure how many times a runner [attempts certain stages of job execution](#job-stages-attempts). When using the Kubernetes executor, you can use variables to -[override Kubernetes CPU and memory allocations for requests and limits](https://docs.gitlab.com/runner/executors/kubernetes/index.html#overwrite-container-resources). +[override Kubernetes CPU and memory allocations for requests and limits](https://docs.gitlab.com/runner/executors/kubernetes/#overwrite-container-resources). ### Git strategy diff --git a/doc/ci/runners/runners_scope.md b/doc/ci/runners/runners_scope.md index c75c465fc433f4339a6f986af0bc1aeac36ed3c5..0cbc00eb939d4181afd820de88c8f8404c997d3a 100644 --- a/doc/ci/runners/runners_scope.md +++ b/doc/ci/runners/runners_scope.md @@ -26,7 +26,7 @@ multiple projects. If you are using GitLab Self-Managed, administrators can: -- [Install GitLab Runner](https://docs.gitlab.com/runner/install/index.html) and register an instance runner. +- [Install GitLab Runner](https://docs.gitlab.com/runner/install/) and register an instance runner. - Configure a maximum number of instance runner [compute minutes for each group](../../administration/cicd/compute_minutes.md#set-the-compute-quota-for-a-group). If you are using GitLab.com: @@ -137,8 +137,8 @@ On GitLab Self-Managed, an administrator can [enable them for all new projects](../../administration/settings/continuous_integration.md#enable-instance-runners-for-new-projects). For existing projects, an administrator must -[install](https://docs.gitlab.com/runner/install/index.html) and -[register](https://docs.gitlab.com/runner/register/index.html) them. +[install](https://docs.gitlab.com/runner/install/) and +[register](https://docs.gitlab.com/runner/register/) them. To enable instance runners for a project: @@ -644,7 +644,7 @@ DETAILS: > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/365078) in GitLab 15.3. The version of GitLab Runner used by your runners should be -[kept up-to-date](https://docs.gitlab.com/runner/index.html#gitlab-runner-versions). +[kept up-to-date](https://docs.gitlab.com/runner/#gitlab-runner-versions). To determine which runners need to be upgraded: diff --git a/doc/ci/testing/code_quality_codeclimate_scanning.md b/doc/ci/testing/code_quality_codeclimate_scanning.md index 587acfbc87648c435143917f250fbd80d6260cd1..f56b123507fbd35fd85457e3eeb579822bfb8668 100644 --- a/doc/ci/testing/code_quality_codeclimate_scanning.md +++ b/doc/ci/testing/code_quality_codeclimate_scanning.md @@ -471,11 +471,11 @@ The same configuration is required if your goal is to [use rootless Podman to ru ### Configure Kubernetes or OpenShift runners -You must set up Docker in a Docker container (Docker-in-Docker) to use Code Quality. The Kubernetes executor [supports Docker-in-Docker](https://docs.gitlab.com/runner/executors/kubernetes/index.html#using-dockerdind). +You must set up Docker in a Docker container (Docker-in-Docker) to use Code Quality. The Kubernetes executor [supports Docker-in-Docker](https://docs.gitlab.com/runner/executors/kubernetes/#using-dockerdind). To ensure Code Quality jobs can run on a Kubernetes executor: -- If you're using TLS to communicate with the Docker daemon, the executor [must be running in privileged mode](https://docs.gitlab.com/runner/executors/kubernetes/index.html#other-configtoml-settings). Additionally, the certificate directory must be [specified as a volume mount](../docker/using_docker_build.md#docker-in-docker-with-tls-enabled-in-kubernetes). +- If you're using TLS to communicate with the Docker daemon, the executor [must be running in privileged mode](https://docs.gitlab.com/runner/executors/kubernetes/#other-configtoml-settings). Additionally, the certificate directory must be [specified as a volume mount](../docker/using_docker_build.md#docker-in-docker-with-tls-enabled-in-kubernetes). - It is possible that the DinD service doesn't start up fully before the Code Quality job starts. This is a limitation documented in [Troubleshooting the Kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes/troubleshooting.html#docker-cannot-connect-to-the-docker-daemon-at-tcpdocker2375-is-the-docker-daemon-running). To resolve the issue, use `before_script` to wait for the Docker daemon to fully boot up. For an example, see the configuration in the `.gitlab-ci.yml` file below. @@ -524,7 +524,7 @@ To ensure that you use the `overlay2` [storage driver](https://docs.docker.com/s - Specify the `DOCKER_HOST` that the Docker CLI communicates with. - Set the `DOCKER_DRIVER` variable to empty. -Use the `before_script` section to wait for the Docker daemon to fully boot up. Since GitLab Runner v16.9, this can also be done [by just setting the `HEALTHCHECK_TCP_PORT` variable](https://docs.gitlab.com/runner/executors/kubernetes/index.html#define-a-list-of-services). +Use the `before_script` section to wait for the Docker daemon to fully boot up. Since GitLab Runner v16.9, this can also be done [by just setting the `HEALTHCHECK_TCP_PORT` variable](https://docs.gitlab.com/runner/executors/kubernetes/#define-a-list-of-services). ```yaml include: @@ -595,7 +595,7 @@ name = "docker:20.10.12-dind" oc adm policy add-scc-to-user -z dind-sa privileged ``` -1. Set the permissions in the [`[runners.kubernetes]` section](https://docs.gitlab.com/runner/executors/kubernetes/index.html#other-configtoml-settings). +1. Set the permissions in the [`[runners.kubernetes]` section](https://docs.gitlab.com/runner/executors/kubernetes/#other-configtoml-settings). 1. Set the job definition stays the same as in Kubernetes case: ```yaml diff --git a/doc/ci/testing/code_quality_troubleshooting.md b/doc/ci/testing/code_quality_troubleshooting.md index 573e39822b4b0b0916c046d4685e11291648c6d3..a392eb19fed2b918d89f2aae74e0ffa15a629ccf 100644 --- a/doc/ci/testing/code_quality_troubleshooting.md +++ b/doc/ci/testing/code_quality_troubleshooting.md @@ -151,7 +151,7 @@ Example: ### Kubernetes If you have access to GitLab Runner configuration and the Kubernetes cluster, -you can [mount a ConfigMap](https://docs.gitlab.com/runner/executors/kubernetes/index.html#configmap-volume). +you can [mount a ConfigMap](https://docs.gitlab.com/runner/executors/kubernetes/#configmap-volume). Replace `gitlab.example.com` with the actual domain of the registry. diff --git a/doc/ci/variables/_index.md b/doc/ci/variables/_index.md index b7b9a79b79ee6582e6b5bcd34b0daf27dfc76ec9..c650153f0a0be82310638a9e76c025165b207ccb 100644 --- a/doc/ci/variables/_index.md +++ b/doc/ci/variables/_index.md @@ -18,7 +18,7 @@ CI/CD variables are a type of environment variable. You can use them to: You can [override variable values](#cicd-variable-precedence) for a specific pipeline when you [run a pipeline manually](../pipelines/_index.md#run-a-pipeline-manually), [run a manual job](../jobs/job_control.md#specify-variables-when-running-manual-jobs), or have them [prefilled in manual pipelines](../pipelines/_index.md#prefill-variables-in-manual-pipelines). -Variable names are limited by the [shell the runner uses](https://docs.gitlab.com/runner/shells/index.html) +Variable names are limited by the [shell the runner uses](https://docs.gitlab.com/runner/shells/) to execute scripts. Each shell has its own set of reserved variable names. To ensure consistent behavior, you should always put variable values in single or double quotes. diff --git a/doc/development/architecture.md b/doc/development/architecture.md index 6a98ba2ed2172851a3659374fe20e0fce604ee37..c3a47b23de214df1ca9b4178d67523fcfb205fd1 100644 --- a/doc/development/architecture.md +++ b/doc/development/architecture.md @@ -452,7 +452,7 @@ GitLab can be considered to have two layers from a process perspective: - [Omnibus](https://github.com/certbot/certbot/blob/master/README.rst) - [Charts](https://github.com/cert-manager/cert-manager/blob/master/README.md) - Configuration: - - [Omnibus](https://docs.gitlab.com/omnibus/settings/ssl/index.html) + - [Omnibus](https://docs.gitlab.com/omnibus/settings/ssl/) - [Charts](https://docs.gitlab.com/charts/installation/tls.html) - [Source](../install/installation.md#using-https) - [GDK](https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/doc/howto/nginx.md) @@ -530,7 +530,7 @@ Geo is a premium feature built to help speed up the development of distributed t - [Project page](https://gitlab.com/gitlab-org/ruby/gems/gitlab-exporter) - Configuration: - [Omnibus](../administration/monitoring/prometheus/gitlab_exporter.md) - - [Charts](https://docs.gitlab.com/charts/charts/gitlab/gitlab-exporter/index.html) + - [Charts](https://docs.gitlab.com/charts/charts/gitlab/gitlab-exporter/) - Layer: Monitoring - Process: `gitlab-exporter` - GitLab.com: [Monitoring of GitLab.com](https://handbook.gitlab.com/handbook/engineering/monitoring/) @@ -542,7 +542,7 @@ GitLab Exporter is a process designed in house that allows us to export metrics - [Project page](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent) - Configuration: - [Omnibus](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/files/gitlab-config-template/gitlab.rb.template) - - [Charts](https://docs.gitlab.com/charts/charts/gitlab/kas/index.html) + - [Charts](https://docs.gitlab.com/charts/charts/gitlab/kas/) The [GitLab agent](../user/clusters/agent/_index.md) is an active in-cluster component for solving GitLab and Kubernetes integration tasks in a secure and @@ -831,7 +831,7 @@ For monitoring deployed apps, see the [Sentry integration docs](../operations/er - Configuration: - [Omnibus](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/files/gitlab-config-template/gitlab.rb.template) - [Charts](https://docs.gitlab.com/charts/charts/gitlab/sidekiq/) - - [minikube Minimal](https://docs.gitlab.com/charts/charts/gitlab/sidekiq/index.html) + - [minikube Minimal](https://docs.gitlab.com/charts/charts/gitlab/sidekiq/) - [Source](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/gitlab.yml.example) - [GDK](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/gitlab.yml.example) - Layer: Core Service (Processor) diff --git a/doc/development/documentation/site_architecture/global_nav.md b/doc/development/documentation/site_architecture/global_nav.md index 462002b90526a37dded203b23966ff24cce7ce18..fbae6af292f940e1f82175636ae35e1689154d30 100644 --- a/doc/development/documentation/site_architecture/global_nav.md +++ b/doc/development/documentation/site_architecture/global_nav.md @@ -272,7 +272,7 @@ URLs must be relative. In addition: - All links in the data file must end with `.html` (with the exception of `index.html` files), and not `.md`. -- For `index.html` files, use the clean (canonical) URL: `path/to/`. For example, `https://docs.gitlab.com/ee/install/index.html` becomes `ee/install/`. +- For `index.html` files, use the clean (canonical) URL: `path/to/`. For example, `https://docs.gitlab.com/ee/install/` becomes `ee/install/`. - Do not start any relative link with a forward slash `/`. - As convention, always wrap URLs in single quotes `'url'`. - Always use the project prefix depending on which project the link you add @@ -285,7 +285,7 @@ Examples of relative URLs: | Full URL | Global nav URL | | -------------------------------------------------------------- | ------------------------------------- | | `https://docs.gitlab.com/ee/api/avatar.html` | `ee/api/avatar.html` | -| `https://docs.gitlab.com/ee/install/index.html` | `ee/install/` | +| `https://docs.gitlab.com/ee/install/` | `ee/install/` | | `https://docs.gitlab.com/omnibus/settings/database.html` | `omnibus/settings/database.html` | | `https://docs.gitlab.com/charts/installation/deployment.html` | `charts/installation/deployment.html` | | `https://docs.gitlab.com/runner/install/docker.html` | `runner/install/docker.html` | diff --git a/doc/development/fips_gitlab.md b/doc/development/fips_gitlab.md index 9776701fde934097166375e5670e273b7ff87545..d0577d93fe15f8e2fa358272ac498956994e3de2 100644 --- a/doc/development/fips_gitlab.md +++ b/doc/development/fips_gitlab.md @@ -274,7 +274,7 @@ all: Now create `charts.yml` in the location specified above and specify tags with a `-fips` suffix. -See our [Charts documentation on FIPS](https://docs.gitlab.com/charts/advanced/fips/index.html) for more details, including +See our [Charts documentation on FIPS](https://docs.gitlab.com/charts/advanced/fips/) for more details, including an [example values file](https://gitlab.com/gitlab-org/charts/gitlab/blob/master/examples/fips/values.yaml) as a reference. You can also use release tags, but the versioning is tricky because each diff --git a/doc/install/aws/_index.md b/doc/install/aws/_index.md index 8f6e4cd5414003c3e5befd2347a992910a402912..7f2e9840666ff0824fde58ce6fc8976511c2bc1d 100644 --- a/doc/install/aws/_index.md +++ b/doc/install/aws/_index.md @@ -531,7 +531,7 @@ Connect to your GitLab instance via **Bastion Host A** using [SSH Agent Forwardi #### Disable Let's Encrypt -Because we're adding our SSL certificate at the load balancer, we do not need the GitLab built-in support for Let's Encrypt. Let's Encrypt [is enabled by default](https://docs.gitlab.com/omnibus/settings/ssl/index.html#enable-the-lets-encrypt-integration) when using an `https` domain, so we must explicitly disable it: +Because we're adding our SSL certificate at the load balancer, we do not need the GitLab built-in support for Let's Encrypt. Let's Encrypt [is enabled by default](https://docs.gitlab.com/omnibus/settings/ssl/#enable-the-lets-encrypt-integration) when using an `https` domain, so we must explicitly disable it: 1. Open `/etc/gitlab/gitlab.rb` and disable it: @@ -652,7 +652,7 @@ Now that we have our EC2 instance ready, follow the [documentation to install Gi #### Add Support for Proxied SSL -As we are terminating SSL at our [load balancer](#load-balancer), follow the steps at [Supporting proxied SSL](https://docs.gitlab.com/omnibus/settings/ssl/index.html#configure-a-reverse-proxy-or-load-balancer-ssl-termination) to configure this in `/etc/gitlab/gitlab.rb`. +As we are terminating SSL at our [load balancer](#load-balancer), follow the steps at [Supporting proxied SSL](https://docs.gitlab.com/omnibus/settings/ssl/#configure-a-reverse-proxy-or-load-balancer-ssl-termination) to configure this in `/etc/gitlab/gitlab.rb`. Remember to run `sudo gitlab-ctl reconfigure` after saving the changes to the `gitlab.rb` file. diff --git a/doc/install/azure/_index.md b/doc/install/azure/_index.md index ab694d2fe100b2bcbbb2917b36061c3743239d22..dd02a105c059ee98d541170b8db6228cfbfb08e0 100644 --- a/doc/install/azure/_index.md +++ b/doc/install/azure/_index.md @@ -191,7 +191,7 @@ To set up the GitLab external URL: 1. Find `external_url` and replace it with your own domain name. For the sake of this example, use the default domain name Azure sets up. Using `https` in the URL - [automatically enables](https://docs.gitlab.com/omnibus/settings/ssl/index.html#lets-encrypt-integration), + [automatically enables](https://docs.gitlab.com/omnibus/settings/ssl/#lets-encrypt-integration), Let's Encrypt, and sets HTTPS by default: ```ruby diff --git a/doc/install/docker/configuration.md b/doc/install/docker/configuration.md index 2380f41bb8152313e17786d923f9813bce3b0473..ae651979b7dd60c23aad542bd4ba29340ebf8361 100644 --- a/doc/install/docker/configuration.md +++ b/doc/install/docker/configuration.md @@ -38,7 +38,7 @@ context of a running container. [SMTP settings](https://docs.gitlab.com/omnibus/settings/smtp.html). The GitLab Docker image doesn't have an SMTP server pre-installed. - 1. If desired [enable HTTPS](https://docs.gitlab.com/omnibus/settings/ssl/index.html). + 1. If desired [enable HTTPS](https://docs.gitlab.com/omnibus/settings/ssl/). 1. Save the file and restart the container to reconfigure GitLab: diff --git a/doc/install/google_cloud_platform/_index.md b/doc/install/google_cloud_platform/_index.md index bf43ac684546fe5bc41850483f5d7405208e9d07..84c61b1b1667f53376ce905387515c444addda93 100644 --- a/doc/install/google_cloud_platform/_index.md +++ b/doc/install/google_cloud_platform/_index.md @@ -121,7 +121,7 @@ here's how you configure GitLab to be aware of the change: ### Configuring HTTPS with the domain name Although not needed, it's strongly recommended to secure GitLab with a -[TLS certificate](https://docs.gitlab.com/omnibus/settings/ssl/index.html). +[TLS certificate](https://docs.gitlab.com/omnibus/settings/ssl/). ### Configuring the email SMTP settings diff --git a/doc/install/install_ai_gateway.md b/doc/install/install_ai_gateway.md index 0eeb0c2727d37bea9d74bd5b8ac6f455f8e85953..1f044dc52e8021164f4ef8c201221e56be4f9223 100644 --- a/doc/install/install_ai_gateway.md +++ b/doc/install/install_ai_gateway.md @@ -72,7 +72,7 @@ Prerequisites: - Working installation of `kubectl`. - Working installation of Helm, version v3.11.0 or later. -For more information, see [Test the GitLab chart on GKE or EKS](https://docs.gitlab.com/charts/quickstart/index.html). +For more information, see [Test the GitLab chart on GKE or EKS](https://docs.gitlab.com/charts/quickstart/). ### Add the AI gateway Helm repository diff --git a/doc/install/requirements.md b/doc/install/requirements.md index 7c431b16cdc6adf7044aaf4a4a27bfae1bf7ab36..e70969a2ff90297fb2f74590f7cdc4ae58f6bc80 100644 --- a/doc/install/requirements.md +++ b/doc/install/requirements.md @@ -140,7 +140,7 @@ To adjust Puma settings: - For the Linux package, see [Puma settings](../administration/operations/puma.md). - For the GitLab Helm chart, see the - [`webservice` chart](https://docs.gitlab.com/charts/charts/gitlab/webservice/index.html). + [`webservice` chart](https://docs.gitlab.com/charts/charts/gitlab/webservice/). ### Workers diff --git a/doc/integration/_index.md b/doc/integration/_index.md index 2daa53a99cc19868a87aeb1c777ea53f47985e15..79c93d033bebd744b77f811efa784f03d6378ae2 100644 --- a/doc/integration/_index.md +++ b/doc/integration/_index.md @@ -68,7 +68,7 @@ As a workaround, do one of the following: - [Adding trusted root certificates to the server](https://manuals.gfi.com/en/kerio/connect/content/server-configuration/ssl-certificates/adding-trusted-root-certificates-to-the-server-1605.html) - [How do you add a certificate authority (CA) to Ubuntu?](https://superuser.com/questions/437330/how-do-you-add-a-certificate-authority-ca-to-ubuntu) - For installations that use the Linux package, add the certificate to the GitLab trusted chain: - 1. [Install the self-signed certificate](https://docs.gitlab.com/omnibus/settings/ssl/index.html#install-custom-public-certificates). + 1. [Install the self-signed certificate](https://docs.gitlab.com/omnibus/settings/ssl/#install-custom-public-certificates). 1. Concatenate the self-signed certificate with the GitLab trusted certificate. The self-signed certificate might be overwritten during upgrades. diff --git a/doc/integration/jira/dvcs/troubleshooting.md b/doc/integration/jira/dvcs/troubleshooting.md index 198410c76112c69dd32ed00e2159fe9a577bbb38..5858ec53be69be77fb9fad665a636fddaa29d36b 100644 --- a/doc/integration/jira/dvcs/troubleshooting.md +++ b/doc/integration/jira/dvcs/troubleshooting.md @@ -40,7 +40,7 @@ Error obtaining access token. Cannot access https://gitlab.example.com from Jira - The [Jira issues integration](../_index.md) requires GitLab to connect to Jira. Any TLS issues that arise from a private certificate authority or self-signed certificate are resolved - [on the GitLab server](https://docs.gitlab.com/omnibus/settings/ssl/index.html#install-custom-public-certificates), + [on the GitLab server](https://docs.gitlab.com/omnibus/settings/ssl/#install-custom-public-certificates), as GitLab is the TLS client. - The Jira development panel requires Jira to connect to GitLab, which causes Jira to be the TLS client. If your GitLab server's certificate is not diff --git a/doc/raketasks/_index.md b/doc/raketasks/_index.md index 7541c9bc6cb5e50fd321a3b95bfe8c88a09a9e05..8055d122641482ff789ff5dd2846ccdc1cb46b3c 100644 --- a/doc/raketasks/_index.md +++ b/doc/raketasks/_index.md @@ -14,7 +14,7 @@ processes. You can perform GitLab Rake tasks by using: -- `gitlab-rake <raketask>` for [Linux package](https://docs.gitlab.com/omnibus/index.html) and [GitLab Helm chart](https://docs.gitlab.com/charts/troubleshooting/kubernetes_cheat_sheet.html#gitlab-specific-kubernetes-information) installations. +- `gitlab-rake <raketask>` for [Linux package](https://docs.gitlab.com/omnibus/) and [GitLab Helm chart](https://docs.gitlab.com/charts/troubleshooting/kubernetes_cheat_sheet.html#gitlab-specific-kubernetes-information) installations. - `bundle exec rake <raketask>` for [self-compiled](../install/installation.md) installations. ## Available Rake tasks diff --git a/doc/topics/autodevops/requirements.md b/doc/topics/autodevops/requirements.md index 6199bde4cb84822a5b2272eea57ef895bb7eef58..b3137859de4197b9287aa0b6113b50ae048a4981 100644 --- a/doc/topics/autodevops/requirements.md +++ b/doc/topics/autodevops/requirements.md @@ -128,7 +128,7 @@ To make full use of Auto DevOps with Kubernetes, you need: Your runner must be configured to run Docker, usually with either the [Docker](https://docs.gitlab.com/runner/executors/docker.html) - or [Kubernetes](https://docs.gitlab.com/runner/executors/kubernetes/index.html) executors, with + or [Kubernetes](https://docs.gitlab.com/runner/executors/kubernetes/) executors, with [privileged mode enabled](https://docs.gitlab.com/runner/executors/docker.html#use-docker-in-docker-with-privileged-mode). The runners don't need to be installed in the Kubernetes cluster, but the Kubernetes executor is easy to use and automatically autoscales. diff --git a/doc/topics/offline/quick_start_guide.md b/doc/topics/offline/quick_start_guide.md index 9d903f70b271473cf23b38fa78463429e341cbf8..1e7e2bc65ce6cc1a09b481636bab1a213f951e0e 100644 --- a/doc/topics/offline/quick_start_guide.md +++ b/doc/topics/offline/quick_start_guide.md @@ -74,7 +74,7 @@ sudo EXTERNAL_URL="http://my-host.internal" dpkg -i <gitlab_package_name>.deb ## Enabling SSL Follow these steps to enable SSL for your fresh instance. These steps reflect those for -[manually configuring SSL in Omnibus's NGINX configuration](https://docs.gitlab.com/omnibus/settings/ssl/index.html#configure-https-manually): +[manually configuring SSL in Omnibus's NGINX configuration](https://docs.gitlab.com/omnibus/settings/ssl/#configure-https-manually): 1. Make the following changes to `/etc/gitlab/gitlab.rb`: diff --git a/doc/topics/runner_fleet_design_guides/gitlab_runner_fleet_config_and_best_practices.md b/doc/topics/runner_fleet_design_guides/gitlab_runner_fleet_config_and_best_practices.md index def61ed0683de716306a690633d0b4c3b9f8ea1d..3b5009a4ea185170797a131b32c970e09fde27e1 100644 --- a/doc/topics/runner_fleet_design_guides/gitlab_runner_fleet_config_and_best_practices.md +++ b/doc/topics/runner_fleet_design_guides/gitlab_runner_fleet_config_and_best_practices.md @@ -522,7 +522,7 @@ As a final step in the deployment phase, you must establish a solution to monito - Network utilization - Disk utilization -See the [Dedicated GitLab Runner monitoring page](https://docs.gitlab.com/runner/monitoring/index.html) for more details on how to proceed. +See the [Dedicated GitLab Runner monitoring page](https://docs.gitlab.com/runner/monitoring/) for more details on how to proceed. ## Optimize diff --git a/doc/update/_index.md b/doc/update/_index.md index f549c800369e5ffc7162ca523ba5addd99e4b18e..8e109ebb898796d391419df94bcdc88310e28302 100644 --- a/doc/update/_index.md +++ b/doc/update/_index.md @@ -171,7 +171,7 @@ To address the above two scenarios, it is advised to do the following prior to u 1. Wait until all jobs are finished. 1. Upgrade GitLab. -1. [Upgrade GitLab Runner](https://docs.gitlab.com/runner/install/index.html) to the same version +1. [Upgrade GitLab Runner](https://docs.gitlab.com/runner/install/) to the same version as your GitLab version. Both versions [should be the same](https://docs.gitlab.com/runner/#gitlab-runner-versions). 1. Unpause your runners and unblock new jobs from starting by reverting the previous `/etc/gitlab/gitlab.rb` change. diff --git a/doc/update/deprecations.md b/doc/update/deprecations.md index f039cb8b4a4d0889fcfd39fc835390986eb3f12c..f887ee639e248f7f76010f2f94218ddc480adca6 100644 --- a/doc/update/deprecations.md +++ b/doc/update/deprecations.md @@ -1622,7 +1622,7 @@ SLES 15 SP6 for continued support. </div> -The SpotBugs [SAST analyzer](https://docs.gitlab.com/ee/user/application_security/sast/index.html#supported-languages-and-frameworks) +The SpotBugs [SAST analyzer](https://docs.gitlab.com/ee/user/application_security/sast/#supported-languages-and-frameworks) can perform a build when the artifacts to be scanned aren't present. While this usually works well for simple projects, it can fail on more complex builds. From GitLab 18.0, to resolve SpotBugs analyzer build failures, you should: diff --git a/doc/update/package/package_troubleshooting.md b/doc/update/package/package_troubleshooting.md index 31655979f59d44814a8f4d604125f37ea4d88766..d55f6a72fdfc36b743e937ec8ddf471802e42e6b 100644 --- a/doc/update/package/package_troubleshooting.md +++ b/doc/update/package/package_troubleshooting.md @@ -18,7 +18,7 @@ sudo gitlab-rake gitlab:check SANITIZE=true For more information on: -- Using `gitlab-ctl` for maintenance, see [Maintenance commands](https://docs.gitlab.com/omnibus/maintenance/index.html). +- Using `gitlab-ctl` for maintenance, see [Maintenance commands](https://docs.gitlab.com/omnibus/maintenance/). - Using `gitlab-rake` for configuration checking, see [Check GitLab configuration](../../administration/raketasks/maintenance.md#check-gitlab-configuration). diff --git a/doc/user/clusters/agent/_index.md b/doc/user/clusters/agent/_index.md index 53c95c6e4b140277576137d7c1d078f3a083dcfc..84a6df57963d9123c395081260a062977ab00e63 100644 --- a/doc/user/clusters/agent/_index.md +++ b/doc/user/clusters/agent/_index.md @@ -51,7 +51,7 @@ You can use agents and receptive agents simultaneously. GitLab supports the following Kubernetes versions. If you want to run GitLab in a Kubernetes cluster, you might need a different version of Kubernetes: -- For the [Helm Chart](https://docs.gitlab.com/charts/installation/cloud/index.html). +- For the [Helm Chart](https://docs.gitlab.com/charts/installation/cloud/). - For [GitLab Operator](https://docs.gitlab.com/operator/installation.html). You can upgrade your diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 37501b2606defac53b37d41b578a68b74ba9cc7c..9eb14a7c30431cd752d68bb3ff2b2b50afa73b69 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -381,7 +381,7 @@ Examples: <!-- The "2." and "4." in the example above are changed to "1." below, to match the style standards on docs.gitlab.com. -See https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#lists +See https://docs.gitlab.com/ee/development/documentation/styleguide/#lists --> 1. First ordered list item @@ -415,7 +415,7 @@ They can even: <!-- The "*" and "+" in the example above are changed to "-" below, to match the style standards on docs.gitlab.com. -See https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#lists +See https://docs.gitlab.com/ee/development/documentation/styleguide/#lists --> Unordered lists can: diff --git a/doc/user/packages/container_registry/build_and_push_images.md b/doc/user/packages/container_registry/build_and_push_images.md index d0f2380aeeedea9d9cf364a0da29e2a6f699cc0b..0d67961dd26cc59e5f7634f0242e4b4da061e88c 100644 --- a/doc/user/packages/container_registry/build_and_push_images.md +++ b/doc/user/packages/container_registry/build_and_push_images.md @@ -213,5 +213,5 @@ deploy: NOTE: This example explicitly calls `docker pull`. If you prefer to implicitly pull the container image using `image:`, -and use either the [Docker](https://docs.gitlab.com/runner/executors/docker.html) or [Kubernetes](https://docs.gitlab.com/runner/executors/kubernetes/index.html) executor, +and use either the [Docker](https://docs.gitlab.com/runner/executors/docker.html) or [Kubernetes](https://docs.gitlab.com/runner/executors/kubernetes/) executor, make sure that [`pull_policy`](https://docs.gitlab.com/runner/executors/docker.html#how-pull-policies-work) is set to `always`. diff --git a/doc/user/permissions.md b/doc/user/permissions.md index 086be7f72d1bb851b4e01fa1be19be11053d0b0d..3039e7047cb8488314d85d20f87d4c86835de077 100644 --- a/doc/user/permissions.md +++ b/doc/user/permissions.md @@ -166,11 +166,11 @@ Guest users and members with the Reporter role cannot do any of these actions. | Clone source and LFS from current project | ✓ | ✓ | | | Clone source and LFS from public projects | ✓ | ✓ | | | Clone source and LFS from internal projects | ✓ | ✓ | Developers and Maintainers: Only if the triggering user is not an external user. | -| Clone source and LFS from private projects | ✓ | ✓ | Only if the triggering user is a member of the project. See also [Usage of private Docker images with `if-not-present` pull policy](https://docs.gitlab.com/runner/security/index.html#usage-of-private-docker-images-with-if-not-present-pull-policy). | +| Clone source and LFS from private projects | ✓ | ✓ | Only if the triggering user is a member of the project. See also [Usage of private Docker images with `if-not-present` pull policy](https://docs.gitlab.com/runner/security/#usage-of-private-docker-images-with-if-not-present-pull-policy). | | Pull container images from current project | ✓ | ✓ | | | Pull container images from public projects | ✓ | ✓ | | | Pull container images from internal projects | ✓ | ✓ | Developers and Maintainers: Only if the triggering user is not an external user. | -| Pull container images from private projects | ✓ | ✓ | Only if the triggering user is a member of the project. See also [Usage of private Docker images with `if-not-present` pull policy](https://docs.gitlab.com/runner/security/index.html#usage-of-private-docker-images-with-if-not-present-pull-policy). | +| Pull container images from private projects | ✓ | ✓ | Only if the triggering user is a member of the project. See also [Usage of private Docker images with `if-not-present` pull policy](https://docs.gitlab.com/runner/security/#usage-of-private-docker-images-with-if-not-present-pull-policy). | | Push container images to current project | ✓ | ✓ | You cannot push container images to other projects. | ### Compliance diff --git a/doc/user/project/deploy_boards.md b/doc/user/project/deploy_boards.md index ea0d78f5ebb6898586bca5bf32ca82de06b752aa..753b3d7ecc2104025c9ba72105420b01571b393c 100644 --- a/doc/user/project/deploy_boards.md +++ b/doc/user/project/deploy_boards.md @@ -92,7 +92,7 @@ To display the deploy boards for a specific [environment](../../ci/environments/ and [GitLab issue #4584](https://gitlab.com/gitlab-org/gitlab/-/issues/4584). 1. [Configure GitLab Runner](../../ci/runners/_index.md) with the [`docker`](https://docs.gitlab.com/runner/executors/docker.html) or - [`kubernetes`](https://docs.gitlab.com/runner/executors/kubernetes/index.html) executor. + [`kubernetes`](https://docs.gitlab.com/runner/executors/kubernetes/) executor. 1. Configure the [Kubernetes integration](../infrastructure/clusters/_index.md) in your project for the cluster. The Kubernetes namespace is of particular note as you need it for your deployment scripts (exposed by the `KUBE_NAMESPACE` deployment variable). diff --git a/doc/user/project/integrations/slack.md b/doc/user/project/integrations/slack.md index 0680e9937256d328652186785d895646116c8fa8..f262613a33c8b8e79a607899e6aaecd553594d84 100644 --- a/doc/user/project/integrations/slack.md +++ b/doc/user/project/integrations/slack.md @@ -140,7 +140,7 @@ To view which of these problems is the cause of the issue: ``` If GitLab does not trust HTTPS connections to itself, -[add your certificate to the GitLab trusted certificates](https://docs.gitlab.com/omnibus/settings/ssl/index.html#install-custom-public-certificates). +[add your certificate to the GitLab trusted certificates](https://docs.gitlab.com/omnibus/settings/ssl/#install-custom-public-certificates). If GitLab does not trust connections to Slack, the GitLab OpenSSL trust store is incorrect. Typical causes are: diff --git a/doc/user/project/repository/signed_commits/x509.md b/doc/user/project/repository/signed_commits/x509.md index e49fbd7522d331c9ec53923d9f4e2a6f5a4bc356..3d11f8636a1ee52e6d37721dcbf7a4b009540133 100644 --- a/doc/user/project/repository/signed_commits/x509.md +++ b/doc/user/project/repository/signed_commits/x509.md @@ -34,7 +34,7 @@ For a commit or tag to be *verified* by GitLab: from the certificate in the signature to a trusted certificate in the GitLab certificate store. This chain may include intermediate certificates supplied in the signature. You may need to add certificates, such as Certificate Authority root certificates, - [to the GitLab certificate store](https://docs.gitlab.com/omnibus/settings/ssl/index.html#install-custom-public-certificates). + [to the GitLab certificate store](https://docs.gitlab.com/omnibus/settings/ssl/#install-custom-public-certificates). - The signing time must be in the time range of the [certificate validity](https://www.rfc-editor.org/rfc/rfc5280.html#section-4.1.2.5), which is usually up to three years. @@ -56,7 +56,7 @@ GitLab checks certificate revocation lists on a daily basis with a background wo recommend using certificates from a PKI that are in line with [RFC 5280](https://www.rfc-editor.org/rfc/rfc5280). - The **Verified** badge is not displayed on the GitLab SaaS offering - because [uploading a custom Certification Authority (CA)](https://docs.gitlab.com/omnibus/settings/ssl/index.html#install-custom-public-certificates) + because [uploading a custom Certification Authority (CA)](https://docs.gitlab.com/omnibus/settings/ssl/#install-custom-public-certificates) is only available to GitLab Self-Managed. - Setting values in the Extended Key Usage (EKU) section of your certificate in addition to the required Key Usage (KU) of `Digital Signature` is likely to cause your commits to @@ -357,7 +357,7 @@ step of the previous [main verification checks](#main-verification-checks). ``` 1. If this fails, add the missing certificates required to establish trust - [to the GitLab certificate store](https://docs.gitlab.com/omnibus/settings/ssl/index.html#install-custom-public-certificates). + [to the GitLab certificate store](https://docs.gitlab.com/omnibus/settings/ssl/#install-custom-public-certificates). 1. After adding more certificates, (if these troubleshooting steps then pass) run the Rake task to [re-verify commits](#re-verify-commits). diff --git a/doc/user/project/service_desk/configure.md b/doc/user/project/service_desk/configure.md index 7c8632f4ad5ca527344dc1fa286417fb033cb8cb..c14f209c5cba57ff4598d44461667e464d09434f 100644 --- a/doc/user/project/service_desk/configure.md +++ b/doc/user/project/service_desk/configure.md @@ -1097,7 +1097,7 @@ from the `incoming_email` and `service_desk_email` mailboxes. ### Helm chart (Kubernetes) The [GitLab Helm chart](https://docs.gitlab.com/charts/) is made up of multiple subcharts, and one of them is -the [Mailroom subchart](https://docs.gitlab.com/charts/charts/gitlab/mailroom/index.html). Configure the +the [Mailroom subchart](https://docs.gitlab.com/charts/charts/gitlab/mailroom/). Configure the [common settings for `incoming_email`](https://docs.gitlab.com/charts/installation/command-line-options.html#incoming-email-configuration) and the [common settings for `service_desk_email`](https://docs.gitlab.com/charts/installation/command-line-options.html#service-desk-email-configuration). diff --git a/doc/user/storage_management_automation.md b/doc/user/storage_management_automation.md index 5e1b7890ec6cae146aad3c5870b24226abca2858..1f39ff37bc0c27cb1966dcccefc896a8a63ea3d2 100644 --- a/doc/user/storage_management_automation.md +++ b/doc/user/storage_management_automation.md @@ -617,7 +617,7 @@ The full script `get_cicd_pipelines_compare_age_threshold_example.sh` is located #!/bin/bash # Required programs: -# - GitLab CLI (glab): https://docs.gitlab.com/ee/editor_extensions/gitlab_cli/index.html +# - GitLab CLI (glab): https://docs.gitlab.com/ee/editor_extensions/gitlab_cli/ # - jq: https://jqlang.github.io/jq/ # Required variables: