Skip to content

Commit 7d32690

Browse files
committed
clarifying that links between distros are links
1 parent 29d1446 commit 7d32690

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -692,6 +692,7 @@ In OpenShift docs:
692692
* All links to internal content is created using `xref` and **must have an anchor ID**.
693693
* Only use `xref` in assemblies, not in modules.
694694
* All links to external websites are created using `link`.
695+
* Links between different 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 need to be in distro-specific files or conditionalized to apply to the relevant distros.
695696

696697
[IMPORTANT]
697698
====

0 commit comments

Comments
 (0)