We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 9261dbd commit 4d7b082Copy full SHA for 4d7b082
contributing_to_docs/doc_guidelines.adoc
@@ -514,6 +514,31 @@ $ oc get endpoints --all-namespaces --template \
514
# subscription-manager list
515
----
516
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
+
542
=== Inline code or commands
543
Do NOT show full commands or command syntax inline within a sentence. The next section covers how to show commands and command syntax.
544
0 commit comments