You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributing_to_docs/doc_guidelines.adoc
+13-6Lines changed: 13 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -438,8 +438,9 @@ Use a gerund in the procedure title, such as "Creating".
438
438
439
439
[IMPORTANT]
440
440
====
441
-
Modules cannot contain xrefs. If you _must_ use a link in your module, use the `link` attribute type and treat it as an external reference.
441
+
Most modules cannot contain xrefs. If you must include a link in a module, use the `link` attribute type and treat it as an external reference. The only exception is release notes modules, which may contain xrefs as long as the module is included in only one location.
442
442
443
+
// TODO: Check w/ Jeana on updating this:
443
444
Use version attributes for the maintainability of xrefs and links whenever you can.
444
445
====
445
446
@@ -457,7 +458,8 @@ A _text snippet_ is an optional component that lets you reuse content in multipl
457
458
458
459
[IMPORTANT]
459
460
====
460
-
Like modules, text snippets cannot contain xrefs. If you _must_ use a link in your snippet, use the `link` attribute type and treat it as an external reference. It is recommended to use version attributes for maintainability of the link.
461
+
// TODO: Jeana:
462
+
Text snippets cannot contain xrefs. If you _must_ use a link in your snippet, use the `link` attribute type and treat it as an external reference. It is recommended to use version attributes for maintainability of the link.
461
463
====
462
464
463
465
In the context of modules and assemblies, text snippets do not include headings or anchor IDs. Examples include the following:
@@ -829,6 +831,11 @@ In OpenShift Container Platform docs:
829
831
830
832
* All links to internal content is created by using an `xref`, and each `xref` **must have an anchor ID**.
831
833
* Only use `xref` in assemblies, not in modules or snippets.
834
+
+
835
+
[IMPORTANT]
836
+
====
837
+
Exception: You may use cross-references (`xref`) in modules only for release notes. The module must only ever be included once from one assembly.
838
+
====
832
839
* All links to external websites are created by using the `link` attribute.
833
840
* Links between different distributions, or _distros_, such as from ROSA to OpenShift Container Platform, are external links and not cross-references. These external links use `link` instead of `xref` and must be in distro-specific files or a conditionalized state to apply to the relevant distros.
834
841
@@ -950,12 +957,12 @@ IMPORTANT: You cannot link to a repository that is hosted on www.github.com. An
950
957
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.
951
958
952
959
==== Guidance for including outside sources
953
-
In general, avoid linking to sources outside of an official Red Hat domain whenever possible.
960
+
In general, avoid linking to sources outside of an official Red Hat domain whenever possible.
954
961
955
-
Some acceptable exceptions to this rule include:
962
+
Some acceptable exceptions to this rule include:
956
963
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.
964
+
1. Links to third-party product documentation when it would be otherwise unreasonable or impossible to write procedures using another product.
965
+
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
966
3. Upstream API references
960
967
961
968
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.
0 commit comments