Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
565f9ee4
Commit
565f9ee4
authored
Feb 03, 2021
by
Alexander Tanayno
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add clarifications about relative links
parent
bc8ea9a8
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
4 additions
and
1 deletion
+4
-1
doc/development/documentation/styleguide/index.md
doc/development/documentation/styleguide/index.md
+4
-1
No files found.
doc/development/documentation/styleguide/index.md
View file @
565f9ee4
...
@@ -997,9 +997,11 @@ To link to internal documentation:
...
@@ -997,9 +997,11 @@ To link to internal documentation:
-
Use relative links to Markdown files in the same repository.
-
Use relative links to Markdown files in the same repository.
-
Do not use absolute URLs or URLs from
`docs.gitlab.com`
.
-
Do not use absolute URLs or URLs from
`docs.gitlab.com`
.
-
Use
`../`
to navigate to higher-level directories.
-
Use
`../`
to navigate to higher-level directories.
-
Don't prepend
`./`
to links to files or directories.
-
Don't prepend
`./`
to links to files or directories.
If you need to link to a file in the same directory or in one of the sub-directories use
`path/to/file.md`
syntax without any prefixes.
-
Don't link relative to root. For example,
`/ee/user/gitlab_com/index.md`
.
-
Don't link relative to root. For example,
`/ee/user/gitlab_com/index.md`
.
Don't:
Don't:
-
`https://docs.gitlab.com/ee/administration/geo/replication/troubleshooting.html`
-
`https://docs.gitlab.com/ee/administration/geo/replication/troubleshooting.html`
...
@@ -1022,6 +1024,7 @@ To link to internal documentation:
...
@@ -1022,6 +1024,7 @@ To link to internal documentation:
-
`../../merge_requests/index.md`
-
`../../merge_requests/index.md`
-
`../../issues/tags.md`
-
`../../issues/tags.md`
-
`../../issues/tags.md#stages`
-
`../../issues/tags.md#stages`
-
`issues/tags.md`
NOTE:
NOTE:
Using the Markdown extension is necessary for the
[
`/help`
](
../index.md#gitlab-help
)
Using the Markdown extension is necessary for the
[
`/help`
](
../index.md#gitlab-help
)
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment