Skip to content

Commit 304548c

Browse files
authored
Merge pull request #100643 from mwerner2113/patch-1
Guidance for including outside sources
2 parents 9e7ed43 + 3193f30 commit 304548c

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -949,6 +949,17 @@ IMPORTANT: You cannot link to a repository that is hosted on www.github.com. An
949949

950950
TIP: If you want to build a link from a URL _without_ changing the text from the actual URL, just print the URL without adding a `[friendly text]` block at the end; it will automatically be rendered as a link.
951951

952+
==== Guidance for including outside sources
953+
In general, avoid linking to sources outside of an official Red Hat domain whenever possible.
954+
955+
Some acceptable exceptions to this rule include:
956+
957+
1. Links to third-party product documentation when it would be otherwise unreasonable or impossible to write procedures using another product.
958+
2. Upstream resources for a feature or component based on an upstream project when re-writing the resource for downstream use would be too arduous to write for too little value, or too difficult to maintain.
959+
3. Upstream API references
960+
961+
If you feel you need to link to an outside source, discuss it with a content strategist, and then make sure you have approval from your PM and engineering stakeholders and the Product Operations team member who works in your area.
962+
952963
=== Links to internal content
953964
There are two scenarios for linking to other assemblies:
954965

0 commit comments

Comments
 (0)