diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-17 03:09:27 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-17 03:09:27 +0000 |
commit | 9345f69894862e02f3491ea3136c3ed2b23fd5b8 (patch) | |
tree | 08a4a1b2861cd5894e2a1146300a206071f06ea3 /doc/development/documentation/styleguide.md | |
parent | d43aaf286fe6b8e8383e73ea580274d8841608d7 (diff) | |
download | gitlab-ce-9345f69894862e02f3491ea3136c3ed2b23fd5b8.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/styleguide.md')
-rw-r--r-- | doc/development/documentation/styleguide.md | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 2ae3cd0a290..d031364964d 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -628,8 +628,17 @@ do not use this option until further notice. ### Links to internal documentation -- To link to internal documentation, use relative links, not absolute URLs. - Use `../` to navigate to high-level directories. Links should not refer to root. +NOTE: **Note:** +_Internal_ refers to documentation in the same project. When linking to documentation in +separate projects (for example, linking to Omnibus docs from GitLab docs), you must use absolute +URLs. + +To link to internal documentation: + +- Use relative links to Markdown files in the same repository. +- Do not use absolute URLs or URLs from `docs.gitlab.com`. +- Use `../` to navigate to higher-level directories. +- Do not link relative to root. For example, `/ee/user/gitlab_com/index.md`. Don't: @@ -652,8 +661,7 @@ do not use this option until further notice. - `../../issues/tags.md` - `../../issues/tags.md#stages` -- Using the Markdown extension is necessary for the [`/help`](index.md#gitlab-help) - section of GitLab. +- Use the Markdown extension for the [`/help`](index.md#gitlab-help) section of GitLab. ### Links requiring permissions |