Skip to content

Commit 55845f2

Browse files
committed
guidance on commenting out callouts in multi-line commands
1 parent 5313c52 commit 55845f2

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1039,6 +1039,24 @@ $ oc adm create-error-template > errors.html
10391039
----
10401040
....
10411041

1042+
* If your command contains multiple lines and uses callout annotations, you must comment out the callout(s) in the codeblock, as shown in the following example:
1043+
+
1044+
....
1045+
To scale based on the percent of CPU utilization, create a `HorizontalPodAutoscaler` object for an existing object:
1046+
1047+
[source,terminal]
1048+
----
1049+
$ oc autoscale <object_type>/<name> \// <1>
1050+
--min <number> \// <2>
1051+
--max <number> \// <3>
1052+
--cpu-percent=<percent> <4>
1053+
----
1054+
<1> Specify the type and name of the object to autoscale.
1055+
<2> Optional: Specify the minimum number of replicas when scaling down.
1056+
<3> Specify the maximum number of replicas when scaling up.
1057+
<4> Specify the target average CPU utilization over all the pods, represented as a percent of requested CPU.
1058+
....
1059+
10421060
* Separate a command and its related example output into individual code blocks.
10431061
This allows the command to be easily copied using the button on
10441062
+++docs.openshift.com+++.

0 commit comments

Comments
 (0)