@@ -750,16 +750,14 @@ _Internal_ refers to documentation in the same project. When linking to document
...
@@ -750,16 +750,14 @@ _Internal_ refers to documentation in the same project. When linking to document
separate projects (for example, linking to Omnibus docs from GitLab docs), you must use absolute
separate projects (for example, linking to Omnibus docs from GitLab docs), you must use absolute
URLs.
URLs.
We don't use absolute URLs like `https://docs.gitlab.com/ee/index.html` to crosslink
Do not use absolute URLs like `https://docs.gitlab.com/ee/index.html` to crosslink
to other docs within the same project. We need to use relative links like `../index.md`
to other docs within the same project. Use relative links to the file, like `../index.md`. (These are converted to HTML when the site is rendered.)
that link to `.md` files to:
Relative linking enables crosslinks to work:
- Make crosslinks work in Review Apps, local previews, and `/help`.
- Make crosslinks work when working on the docs locally, to verify that links to
- in Review Apps, local previews, and `/help`.
other doc pages work before pushing new commits.
- when working on the docs locally, so you can verify that they work as early as possible in the process.
- Make crosslinks work when browsing the doc files from within the `gitlab`, `gitlab-runner`,
- within the GitLab UI when browsing doc files in their respective repositories. For example, the links displayed at <https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc#gitlab-docs>.
`omnibus-gitlab`, and `charts` repositories. For example: