diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-25 09:09:10 +0000 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-25 09:09:10 +0000 |
| commit | b98fa9ef3d5bead417ae2f325cb64637883264e9 (patch) | |
| tree | 409f2002dd056f12d82d3959b3e6f012c4087123 /doc/development/documentation | |
| parent | 7e3005967df23a957fe1998c8de4f50b412e69e7 (diff) | |
| download | gitlab-ce-b98fa9ef3d5bead417ae2f325cb64637883264e9.tar.gz | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation')
| -rw-r--r-- | doc/development/documentation/styleguide.md | 14 |
1 files changed, 4 insertions, 10 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 06c1e1f9bc9..b456887bd08 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -580,21 +580,15 @@ do not use this option until further notice. ### Links to internal documentation -- To link to internal documentation, use relative links, not full URLs. +- To link to internal documentation, use relative links, not absolute URLs. Use `../` to navigate to high-level directories. Links should not refer to root. Don't: - ```md - [Geo Troubleshooting](https://docs.gitlab.com/ee/administration/geo/replication/troubleshooting.html) - [Geo Troubleshooting](/ee/administration/geo/replication/troubleshooting.md) - ``` - - Do: + - `https://docs.gitlab.com/ee/administration/geo/replication/troubleshooting.html` + - `/ee/administration/geo/replication/troubleshooting.md` - ```md - [Geo Troubleshooting](../../geo/replication/troubleshooting.md) - ``` + Do: `../../geo/replication/troubleshooting.md` - Always add the file name `file.md` at the end of the link with the `.md` extension, not `.html`. |