Commit c6a0917a authored by Mike Jang's avatar Mike Jang Committed by Mike Lewis

Describe authoritative external links

parent d9f8f1d2
...@@ -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:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment