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
c6a0917a
Commit
c6a0917a
authored
Jun 05, 2020
by
Mike Jang
Committed by
Mike Lewis
Jun 05, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Describe authoritative external links
parent
d9f8f1d2
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
7 additions
and
0 deletions
+7
-0
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+7
-0
No files found.
doc/development/documentation/styleguide.md
View file @
c6a0917a
...
@@ -728,6 +728,7 @@ We include guidance for links in the following categories:
...
@@ -728,6 +728,7 @@ We include guidance for links in the following categories:
-
How to set up
[
criteria
](
#basic-link-criteria
)
for configuring a link.
-
How to set up
[
criteria
](
#basic-link-criteria
)
for configuring a link.
-
What to set up when
[
linking to a `help`
](
../documentation/index.md#linking-to-help
)
page.
-
What to set up when
[
linking to a `help`
](
../documentation/index.md#linking-to-help
)
page.
-
How to set up
[
links to internal documentation
](
#links-to-internal-documentation
)
for cross-references.
-
How to set up
[
links to internal documentation
](
#links-to-internal-documentation
)
for cross-references.
-
How to set up
[
links to external documentation
](
#links-to-external-documentation
)
for authoritative sources.
-
When to use
[
links requiring permissions
](
#links-requiring-permissions
)
.
-
When to use
[
links requiring permissions
](
#links-requiring-permissions
)
.
-
How to set up a
[
link to a video
](
#link-to-video
)
.
-
How to set up a
[
link to a video
](
#link-to-video
)
.
-
How to
[
include links with version text
](
#text-for-documentation-requiring-version-text
)
.
-
How to
[
include links with version text
](
#text-for-documentation-requiring-version-text
)
.
...
@@ -780,6 +781,12 @@ To link to internal documentation:
...
@@ -780,6 +781,12 @@ To link to internal documentation:
NOTE:
**Note**
:
NOTE:
**Note**
:
Using the Markdown extension is necessary for the
[
`/help`
](
index.md#gitlab-help
)
section of GitLab.
Using the Markdown extension is necessary for the
[
`/help`
](
index.md#gitlab-help
)
section of GitLab.
### Links to external documentation
When describing interactions with external software, it's often helpful to include links to external
documentation. When possible, make sure that you are linking to an
**authoritative**
source.
For example, if you're describing a feature in Microsoft's Active Directory, include a link to official Microsoft documentation.
### Links requiring permissions
### Links requiring permissions
Don't link directly to:
Don't link directly to:
...
...
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