Skip to content

Commit 7690ed5

Browse files
authored
Merge pull request #47975 from kalexand-rh/callouts
guidance on commenting out callouts in multi-line commands
2 parents 1e69311 + 55845f2 commit 7690ed5

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
@@ -1047,6 +1047,24 @@ $ oc adm create-error-template > errors.html
10471047
----
10481048
....
10491049

1050+
* 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:
1051+
+
1052+
....
1053+
To scale based on the percent of CPU utilization, create a `HorizontalPodAutoscaler` object for an existing object:
1054+
1055+
[source,terminal]
1056+
----
1057+
$ oc autoscale <object_type>/<name> \// <1>
1058+
--min <number> \// <2>
1059+
--max <number> \// <3>
1060+
--cpu-percent=<percent> <4>
1061+
----
1062+
<1> Specify the type and name of the object to autoscale.
1063+
<2> Optional: Specify the minimum number of replicas when scaling down.
1064+
<3> Specify the maximum number of replicas when scaling up.
1065+
<4> Specify the target average CPU utilization over all the pods, represented as a percent of requested CPU.
1066+
....
1067+
10501068
* Separate a command and its related example output into individual code blocks.
10511069
This allows the command to be easily copied using the button on
10521070
+++docs.openshift.com+++.

0 commit comments

Comments
 (0)