Skip to main content

Linking Standard

Summary​

This standard defines durable internal, external, cross-reference, and lifecycle-aware linking rules.

Audience​

  • Documentation authors
  • Documentation maintainers

Reference Content​

  • Prefer relative Markdown links for pages maintained in the same documentation set.
  • Link to the most specific stable page that answers the reader’s need.
  • Use descriptive link text that makes sense out of context.
  • Do not use “click here,” raw URLs, or repeated links to the same destination in one section.
  • Validate paths, filename case, anchors, and redirects during review.

Use authoritative, stable, HTTPS sources. Explain why an external source is relevant. Do not link to private systems from public or customer-visible pages.

Lifecycle handling​

When moving or renaming published content, preserve inbound links with an approved redirect. Update related-document metadata and navigation in the same change. Deprecated pages must link to an approved replacement when one exists.

A page cannot reach approved status while required links are broken or inaccessible to its declared visibility audience.

See Also​

Keywords​

  • Internal links
  • External links
  • Redirects

Revision Information​

  • Last reviewed: 2026-07-14
  • Owner: documentation-team
  • Status: Approved