diff --git a/doc/.vale/gitlab/InternalLinkFormat.yml b/doc/.vale/gitlab/InternalLinkFormat.yml index be09a020846c9b9dc381fe09a8730c69a109c446..fe8fae0558cea3609ebf0ad5febc46289b511442 100644 --- a/doc/.vale/gitlab/InternalLinkFormat.yml +++ b/doc/.vale/gitlab/InternalLinkFormat.yml @@ -1,13 +1,13 @@ --- # Error: gitlab.InternalLinkFormat # -# Checks that internal link paths don't start with './', which is not needed. +# Checks that internal link paths don't start with '/' or './'. # # 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 './'." +message: "Edit the link so it does not start with '/' or './'." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: - - '\[[^\]]+\]\(\.\/.*?\)' + - '\[[^\]]+\]\(\.?\/(?!uploads|documentation).*?\)' diff --git a/doc/administration/geo/index.md b/doc/administration/geo/index.md index 41b0d16aa2dbb0087a4fe61158ea52c406412932..2b5ac15a2c9e7996250d3d87ce060a3e29c6a556 100644 --- a/doc/administration/geo/index.md +++ b/doc/administration/geo/index.md @@ -58,7 +58,7 @@ the difference between Geo and Gitaly Cluster, see [Comparison to Geo](../gitaly ## How it works -This is a brief summary of how Geo works in your GitLab environment. For a more detailed information, see the [Geo Development page](/ee/development/geo.md). +This is a brief summary of how Geo works in your GitLab environment. For a more detailed information, see the [Geo Development page](../../development/geo.md). Your Geo instance can be used for cloning and fetching projects, in addition to reading any data. This makes working with large repositories over large distances much faster. diff --git a/doc/architecture/blueprints/_template.md b/doc/architecture/blueprints/_template.md index bb1f0168e2c719e7f10f8e51afcd260fb13c3892..f4fe0c51d03aa534820b9bd6fbbcacd6e2f3e0d2 100644 --- a/doc/architecture/blueprints/_template.md +++ b/doc/architecture/blueprints/_template.md @@ -33,13 +33,13 @@ Before you start: To get started with a blueprint you can use this template to inform you about what you may want to document in it at the beginning. This content will change -/ evolve as you move forward with the proposal. You are not constrained by the +/ evolve as you move forward with the proposal. You are not constrained by the content in this template. If you have a good idea about what should be in your blueprint, you can ignore the template, but if you don't know yet what should be in it, this template might be handy. - **Fill out this file as best you can.** At minimum, you should fill in the - "Summary", and "Motivation" sections. These can be brief and may be a copy + "Summary", and "Motivation" sections. These can be brief and may be a copy of issue or epic descriptions if the initiative is already on Product's roadmap. - **Create a MR for this blueprint.** Assign it to an Architecture Evolution @@ -60,7 +60,7 @@ If there are new details that belong in the blueprint, edit the blueprint. Once a feature has become "implemented", major changes should get new blueprints. The canonical place for the latest set of instructions (and the likely source -of this file) is [here](/doc/architecture/blueprints/_template.md). +of this file) is [here](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/architecture/blueprints/_template.md). Blueprint statuses you can use: @@ -143,7 +143,7 @@ optional. <!-- This is where we get down to the specifics of what the proposal actually is, -but keep it simple! This should have enough detail that reviewers can +but keep it simple! This should have enough detail that reviewers can understand exactly what you're proposing, but should not include things like API designs or implementation. The "Design Details" section below is for the real nitty-gritty. diff --git a/doc/architecture/blueprints/bundle_uri/index.md b/doc/architecture/blueprints/bundle_uri/index.md index a056649a79872d93a602fd48350990207557b33a..e7cea9483d1a0e357bd5551959af23b92ab8fdbe 100644 --- a/doc/architecture/blueprints/bundle_uri/index.md +++ b/doc/architecture/blueprints/bundle_uri/index.md @@ -34,12 +34,12 @@ objects from the server is reduced, putting less load on the server's CPU. When a user pushes changes, it usually kicks off a CI pipeline with a bunch of jobs. When the CI runners all clone the repository from scratch, -if they use [`git clone`](/ee/ci/pipelines/settings.md#choose-the-default-git-strategy), +if they use [`git clone`](../../../ci/pipelines/settings.md#choose-the-default-git-strategy), they all start negotiating with the server what they need to clone. This is really CPU intensive for the server. Some time ago we've introduced the -[pack-objects](/ee/administration/gitaly/configure_gitaly.md#pack-objects-cache), +[pack-objects](../../../administration/gitaly/configure_gitaly.md#pack-objects-cache), but it has some pitfalls. When the tip of a branch changes, a new packfile needs to be calculated, and the cache needs to be refreshed. diff --git a/doc/architecture/blueprints/cells/impacted_features/snippets.md b/doc/architecture/blueprints/cells/impacted_features/snippets.md index f77879907df0c2bb6bc045423a9a4daeaf6df1a1..63e6a062ffb2ee93ece1f465535409e8683a06f4 100644 --- a/doc/architecture/blueprints/cells/impacted_features/snippets.md +++ b/doc/architecture/blueprints/cells/impacted_features/snippets.md @@ -52,5 +52,5 @@ Snippets are scoped to an Organization because Gitaly is confined to a Cell. ## 4.2. Cons -- We will break [snippet discovery](/ee/user/snippets.md#discover-snippets). +- We will break [snippet discovery](../../../../user/snippets.md#discover-snippets). - Snippet access may become subordinate to the visibility of the Organization. diff --git a/doc/architecture/blueprints/epss/index.md b/doc/architecture/blueprints/epss/index.md index 8a13839f3a431e687ad0d73c831d548fbc3145cb..59ec629703f7e63aa7e93630154be1b4256fdc7f 100644 --- a/doc/architecture/blueprints/epss/index.md +++ b/doc/architecture/blueprints/epss/index.md @@ -46,7 +46,7 @@ If there are new details that belong in the blueprint, edit the blueprint. Once a feature has become "implemented", major changes should get new blueprints. The canonical place for the latest set of instructions (and the likely source -of this file) is [here](/doc/architecture/blueprints/_template.md). +of this file) is [here](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/architecture/blueprints/_template.md). Blueprint statuses you can use: diff --git a/doc/architecture/blueprints/rapid_diffs/index.md b/doc/architecture/blueprints/rapid_diffs/index.md index b2dd847751ff7607d1743b3c8c15ff37d8e1d566..0804933b0e346ca220f437d013401c6712104ac3 100644 --- a/doc/architecture/blueprints/rapid_diffs/index.md +++ b/doc/architecture/blueprints/rapid_diffs/index.md @@ -115,7 +115,7 @@ Simplicity is the opposite of complexity. This uses a definition of simple and c ### Done -GitLab has an existing [definition of done](/ee/development/contributing/merge_request_workflow.md#definition-of-done) which is geared primarily toward identifying when an MR is ready to be merged. +GitLab has an existing [definition of done](../../../development/contributing/merge_request_workflow.md#definition-of-done) which is geared primarily toward identifying when an MR is ready to be merged. In addition to the items in the GitLab definition of done, work on RRD should also adhere to the following requirements: diff --git a/doc/architecture/blueprints/work_items/index.md b/doc/architecture/blueprints/work_items/index.md index 7e7b80e66bdfbda7c76762c211edac09f4a87508..6b9c2e38992ab4f06c6bed6cb946f93144505999 100644 --- a/doc/architecture/blueprints/work_items/index.md +++ b/doc/architecture/blueprints/work_items/index.md @@ -30,11 +30,11 @@ Base type for issue, requirement, test case, incident and task (this list is pla A set of predefined types for different categories of work items. Currently, the available types are: -- [Incident](/ee/operations/incident_management/incidents.md) -- [Test case](/ee/ci/test_cases/index.md) -- [Requirement](/ee/user/project/requirements/index.md) -- [Task](/ee/user/tasks.md) -- [OKRs](/ee/user/okrs.md) +- [Incident](../../../operations/incident_management/incidents.md) +- [Test case](../../../ci/test_cases/index.md) +- [Requirement](../../../user/project/requirements/index.md) +- [Task](../../../user/tasks.md) +- [OKRs](../../../user/okrs.md) Work is underway to convert existing objects to Work Item Types or add new ones: diff --git a/doc/development/go_guide/go_upgrade.md b/doc/development/go_guide/go_upgrade.md index 288325c38fd34fe5cdc315192fb94dee4d837986..6483fd52b70e763a3ee498efb4bb32eaae13092c 100644 --- a/doc/development/go_guide/go_upgrade.md +++ b/doc/development/go_guide/go_upgrade.md @@ -81,7 +81,7 @@ if you need help finding the correct person or labels: [the product page](https://handbook.gitlab.com/handbook/product/categories/) or the [feature page](https://handbook.gitlab.com/handbook/product/categories/features/). - If you still can't find the engineering manager, use - [Git blame](/ee/user/project/repository/files/git_blame.md) to identify a maintainer + [Git blame](../../user/project/repository/files/git_blame.md) to identify a maintainer involved in the project. 1. Create an upgrade issue for each dependency in the diff --git a/doc/user/application_security/api_security/api_discovery/index.md b/doc/user/application_security/api_security/api_discovery/index.md index 7ad70c648f8b239eccc23f5c986af28156b9cecb..7f44d57c8e0bfd458c73eb053cfc61fc4396997a 100644 --- a/doc/user/application_security/api_security/api_discovery/index.md +++ b/doc/user/application_security/api_security/api_discovery/index.md @@ -53,7 +53,7 @@ Only applications that are built as Spring Boot [executable JARs](https://docs.s The easiest way to run API Discovery is through a pipeline job based on our CI template. When running in this method, you provide a container image that has the required dependencies installed (such as an appropriate Java runtime). See [Image Requirements](#image-requirements) for more information. -1. A container image that meets the [image requirements](#image-requirements) is uploaded to a container registry. If the container registry requires authentication see [this help section](/ee/ci/docker/using_docker_images.md#access-an-image-from-a-private-container-registry). +1. A container image that meets the [image requirements](#image-requirements) is uploaded to a container registry. If the container registry requires authentication see [this help section](../../../../ci/docker/using_docker_images.md#access-an-image-from-a-private-container-registry). 1. In a job in the `build` stage, build your application and configure the resulting Spring Boot executable JAR as a job artifact. 1. Include the API Discovery template in your `.gitlab-ci.yml` file. diff --git a/doc/user/group/saml_sso/troubleshooting_scim.md b/doc/user/group/saml_sso/troubleshooting_scim.md index abdb6c07f2d0af82a8345660d1590cf4d2964fc6..33bfd90c94c06484151ba8ef30d9f9cca1137dd0 100644 --- a/doc/user/group/saml_sso/troubleshooting_scim.md +++ b/doc/user/group/saml_sso/troubleshooting_scim.md @@ -194,14 +194,14 @@ this: 1. Optional. If you did not save your SCIM token when you first configured SCIM, [generate a new token](scim_setup.md#configure-gitlab). If you generate a new SCIM token, you **must** update the token in your identity provider's SCIM configuration, or SCIM will stop working. 1. Locate your SCIM token. -1. Use the API to [get a single SCIM provisioned user](/ee/development/internal_api/index.md#get-a-single-scim-provisioned-user). +1. Use the API to [get a single SCIM provisioned user](../../../development/internal_api/index.md#get-a-single-scim-provisioned-user). 1. Check the returned information to make sure that: - The user's identifier (`id`) and email match what your identity provider is sending. - `active` is set to `false`. If any of this information does not match, [contact GitLab Support](https://support.gitlab.com/). -1. Use the API to [update the SCIM provisioned user's `active` value to `true`](/ee/development/internal_api/index.md#update-a-single-scim-provisioned-user). +1. Use the API to [update the SCIM provisioned user's `active` value to `true`](../../../development/internal_api/index.md#update-a-single-scim-provisioned-user). 1. If the update returns a status code `204`, have the user attempt to sign in using SAML SSO. diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 26ee4fc3333e2a5d96db109192b929768c677e23..d1fbac8621acad8e025eaf492a4ffa5e39949263 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -1853,10 +1853,10 @@ This example links to `<wiki_root>/documentation`: [Link to Related Page](/documentation) ``` -This example links to `<wiki_root>/miscellaneous.md`: +This example links to `<wiki_root>/documentation.md`: ```markdown -[Link to Related Page](/miscellaneous.md) +[Link to Related Page](/documentation.md) ``` ### diagrams.net editor