Documented format for example URL paths

dougbtv · Feb 8, 2017 · 931feb0 · 931feb0
1 parent 0ee2a2b
commit 931feb0
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/contributing_to_docs/doc_guidelines.adoc b/contributing_to_docs/doc_guidelines.adoc
@@ -161,6 +161,13 @@ In OpenShift docs:
 Do not split link paths across lines when wrapping text. This will cause issues with the doc builds.
 ====
 
+=== Example URLs
+To provide an example URL path that you do not want to render as a hyperlink, use this format:
+
+....
+`\https://www.example.com`
+....
+
 === Internal Cross-References
 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".