Skip to content

Commit 4d7b082

Browse files
committed
Add guidance on code snip continuation
1 parent 9261dbd commit 4d7b082

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

contributing_to_docs/doc_guidelines.adoc

+25
Original file line numberDiff line numberDiff line change
@@ -514,6 +514,31 @@ $ oc get endpoints --all-namespaces --template \
514514
# subscription-manager list
515515
----
516516

517+
* For snippets or sections of a larger file, use an ellipsis (`...`) to show that
518+
the file continues before and/or after the quoted block:
519+
+
520+
----
521+
apiVersion: v1
522+
kind: Pod
523+
metadata:
524+
labels:
525+
test: liveness
526+
...
527+
----
528+
+
529+
or
530+
+
531+
----
532+
...
533+
spec:
534+
containers:
535+
- args:
536+
image: k8s.gcr.io/liveness
537+
...
538+
----
539+
+
540+
Do not use `[...]`, `<snip>`, or any other variant.
541+
517542
=== Inline code or commands
518543
Do NOT show full commands or command syntax inline within a sentence. The next section covers how to show commands and command syntax.
519544

0 commit comments

Comments
 (0)