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
+5Lines changed: 5 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -156,6 +156,11 @@ In OpenShift docs:
156
156
* all links to internal topics are created using `xref` and **must have an anchor ID**.
157
157
* all links to external websites are created using `link`.
158
158
159
+
[IMPORTANT]
160
+
====
161
+
Do not split link paths across lines when wrapping text. This will cause issues with the doc builds.
162
+
====
163
+
159
164
=== Internal Cross-References
160
165
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".
0 commit comments