Skip to content

Commit 3b52dd1

Browse files
authored
Merge pull request #3208 from ahardin-rh/doc-guideline-link-wrap
Added IMPORTANT box about not splitting links across lines
2 parents 7b14571 + 55f4d20 commit 3b52dd1

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,11 @@ In OpenShift docs:
156156
* all links to internal topics are created using `xref` and **must have an anchor ID**.
157157
* all links to external websites are created using `link`.
158158

159+
[IMPORTANT]
160+
====
161+
Do not split link paths across lines when wrapping text. This will cause issues with the doc builds.
162+
====
163+
159164
=== Internal Cross-References
160165
Whenever possible the link to another topic should be part of the actual sentence. Avoid creating links as a separate sentence that begins with "See [this topic] for more information on x".
161166

0 commit comments

Comments
 (0)