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
5418083d
Commit
5418083d
authored
Mar 17, 2020
by
Nick Gaskill
Committed by
Evan Read
Mar 17, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Docs styleguide on internal links
parent
18111713
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
12 additions
and
4 deletions
+12
-4
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+12
-4
No files found.
doc/development/documentation/styleguide.md
View file @
5418083d
...
...
@@ -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
...
...
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