Merge pull request #25315 from abrennan89/mastercode

[Serverless] Update code block format for commands

Author: sheriff-rh

modules/apiserversource-kn.adoc

@@ -9,7 +9,7 @@ This section describes the steps required to create an ApiServerSource using `kn
 
 .Prerequisites
 
-* You must have the `kn` CLI installed.
+* You must have {ServerlessProductName}, the Knative Serving and Eventing components, and the `kn` CLI installed.
 
 .Procedure
 
@@ -21,7 +21,7 @@ This section describes the steps required to create an ApiServerSource using `kn
 $ kn source apiserver create <event_source_name> --sink broker:<broker_name> --resource "event:v1" --service-account <service_account_name> --mode Resource
 ----
 
-. Create a Knative service that dumps incoming messages to its log:
+. To check that the ApiServerSource is set up correctly, create a Knative service that dumps incoming messages to its log:
 +
 
 [source,terminal]
@@ -37,20 +37,21 @@ $ kn service create <service_name> --image quay.io/openshift-knative/knative-eve
 $ kn trigger create <trigger_name> --sink svc:<service_name>
 ----
 
+
 . Create events by launching a Pod in the default namespace:
 +
 
 [source,terminal]
 ----
-$ oc create deployment hello-node --image=quay.io/openshift-knative/knative-eventing-sources-event-display
+$ oc create deployment hello-node --image quay.io/openshift-knative/knative-eventing-sources-event-display:latest
 ----
 
 . Check that the controller is mapped correctly by inspecting the output generated by the following command:
 +
 
 [source,terminal]
 ----
-$ kn source apiserver describe testevents
+$ kn source apiserver describe <source_name>
 ----
 
 +
@@ -59,7 +60,7 @@ $ kn source apiserver describe testevents
 
 [source,terminal]
 ----
-Name:                testevents
+Name:                mysource
 Namespace:           default
 Annotations:         sources.knative.dev/creator=developer, sources.knative.dev/lastModifier=developer
 Age:                 3m
@@ -101,10 +102,9 @@ $ oc get pods
 $ oc logs $(oc get pod -o name | grep event-display) -c user-container
 ----
 
-+
-.Example output
 +
 
+.Example output
 [source,terminal]
 ----
 ☁️  cloudevents.Event

modules/creating-serverless-apps-kn.adoc

@@ -13,12 +13,12 @@ The following procedure describes how you can create a basic serverless applicat
 
 .Procedure
 
-. Create the Knative service by entering the following command:
+* Create a Knative service:
 +
 
 [source,terminal]
 ----
-$ kn service create <service-name> --image <image> --env <key=value>
+$ kn service create <service_name> --image <image> --env <key=value>
 ----
 
 +

modules/interacting-serverless-apps-http2-gRPC.adoc

@@ -25,7 +25,7 @@ $ oc -n knative-serving-ingress get svc kourier
 ----
 
 +
-.Example output:
+.Example output
 +
 
 [source,terminal]
@@ -35,15 +35,11 @@ kourier   LoadBalancer   172.30.51.103   a83e86291bcdd11e993af02b7a65e514-335442
 ----
 
 +
-The public address is surfaced in the `EXTERNAL-IP` field.
-In this case, it would be `a83e86291bcdd11e993af02b7a65e514-33544245.us-east-1.elb.amazonaws.com`.
+The public address is surfaced in the `EXTERNAL-IP` field, and in this case is `a83e86291bcdd11e993af02b7a65e514-33544245.us-east-1.elb.amazonaws.com`.
 
 . Manually set the host header of your HTTP request to the application’s host, but direct the request itself against the public address of the ingress gateway.
 +
-The following example uses the information obtained from the steps in  _Verifying your serverless application deployment_:
-+
 
-.Example command
 [source,terminal]
 ----
 $ curl -H "Host: hello-default.example.com" a83e86291bcdd11e993af02b7a65e514-33544245.us-east-1.elb.amazonaws.com

modules/kn-trigger-describe.adoc

@@ -9,15 +9,20 @@ The `kn trigger describe` command prints information about a trigger.
 
 .Procedure
 
-To print information about a trigger, enter the following command:
+* Enter the command:
++
+
+[source,terminal]
 ----
-$ kn trigger describe <TRIGGER-NAME>
+$ kn trigger describe <trigger_name>
 ----
 
-Example output:
++
+.Example output
++
 
+[source,terminal]
 ----
-$ kn trigger describe ping
 Name:         ping
 Namespace:    default
 Labels:       eventing.knative.dev/broker=default

modules/kn-trigger-filtering.adoc

@@ -5,16 +5,18 @@
 [id="kn-trigger-filtering_{context}"]
 = Filtering events using triggers
 
-In the following trigger example, only events with attribute `type: dev.knative.samples.helloworld` will reach the event consumer.
+In the following trigger example, only events with the attribute `type: dev.knative.samples.helloworld` will reach the event sink.
 
+[source,terminal]
 ----
-$ kn trigger create foo --broker default --filter type=dev.knative.samples.helloworld --sink svc:mysvc
+$ kn trigger create <trigger_name> --broker <broker_name> --filter type=dev.knative.samples.helloworld --sink svc:<service_name>
 ----
 
 You can also filter events using multiple attributes. The following example shows how to filter events using the type, source, and extension attributes.
 
+[source,terminal]
 ----
-$ kn trigger create foo --broker default --sink svc:mysvc \
+$ kn trigger create <trigger_name> --broker <broker_name> --sink svc:<service_name> \
 --filter type=dev.knative.samples.helloworld \
 --filter source=dev.knative.samples/helloworldsource \
 --filter myextension=my-extension-value

modules/kn-trigger-list.adoc

@@ -8,24 +8,33 @@
 The `kn trigger list` command prints a list of available triggers.
 
 .Procedure
-
-* To print a list of available triggers, enter the following command:
+. Print a list of available triggers:
 +
+
+[source,terminal]
 ----
 $ kn trigger list
 ----
+
 +
-Example output:
+.Example output:
 +
+
+[source,terminal]
 ----
-$ kn trigger list
 NAME    BROKER    SINK           AGE   CONDITIONS   READY   REASON
 email   default   svc:edisplay   4s    5 OK / 5     True
 ping    default   svc:edisplay   32s   5 OK / 5     True
 ----
 
-* To print a list of triggers in JSON format, enter the following command:
+[id="kn-trigger-list-json_{context}"]
+= Listing triggers using `kn` in JSON format
+
+.Procedure
+. Print a list of triggers in JSON format:
 +
+
+[source,terminal]
 ----
 $ kn trigger list -o json
 ----

modules/kn-trigger-update.adoc

@@ -5,27 +5,27 @@
 [id="kn-trigger-update_{context}"]
 = Updating a trigger using `kn`
 
-You can use the `kn trigger update` command with certain flags to quickly update attributes of a trigger.
+You can use the `kn trigger update` command with certain flags to update attributes for a trigger.
 
-.Procedure
+.Example
 
-To update a trigger, enter the following command:
-----
-$ kn trigger update NAME --filter KEY=VALUE --sink SINK [flags]
-----
+. Update a trigger to filter exact event attributes that match incoming events, such as `type=knative.dev.event`:
 
-You can update a trigger to filter exact event attributes that match incoming events, such as `type=knative.dev.event`. For example:
+[source,terminal]
 ----
-$ kn trigger update mytrigger --filter type=knative.dev.event
+$ kn trigger update <trigger_name> --filter type=knative.dev.event
 ----
 
-You can also remove a filter attribute from a trigger.
-For example, you can remove the filter attribute with key `type`:
+. Remove the filter attribute with key `type`:
+
+[source,terminal]
 ----
-$ kn trigger update mytrigger --filter type-
+$ kn trigger update <trigger_name> --filter type-
 ----
 
-The following example shows how to update the sink of a trigger to `svc:new-service`:
+. Update the sink of a trigger to use a service named `event-display`:
+
+[source,terminal]
 ----
-$ kn trigger update mytrigger --sink svc:new-service
+$ kn trigger update <trigger_name> --sink svc:event-display
 ----

modules/knative-serving-concurrent-autoscaling-requests.adoc

@@ -5,9 +5,9 @@
 [id="knative-serving-concurrent-autoscaling-requests_{context}"]
 = Configuring concurrent requests for Knative Serving autoscaling
 
-You can specify the number of concurrent requests that should be handled by each instance of an application (revision container) by adding the `target` annotation or the `containerConcurrency` field in the revision template.
+You can specify the number of concurrent requests that should be handled by each instance of a revision container, or application, by adding the `target` annotation or the `containerConcurrency` field in the revision template.
 
-Here is an example of `target` being used in a revision template:
+.Example revision template YAML using target annotation
 
 [source,yaml]
 ----
@@ -25,7 +25,8 @@ spec:
       - image: myimage
 ----
 
-Here is an example of `containerConcurrency` being used in a revision template:
+.Example revision template YAML using containerConcurrency annotation
+
 [source,yaml]
 ----
 apiVersion: serving.knative.dev/v1
@@ -57,7 +58,7 @@ If the `containerConcurrency` value is less than the `target` value, the `target
 
 The default target for the number of concurrent requests is `100`, but you can override this value by adding or modifying the `autoscaling.knative.dev/target` annotation value in the revision template.
 
-Here is an example of how this annotation is used in the revision template to set the target to `50`.
+Here is an example of how this annotation is used in the revision template to set the target to `50`:
 
 [source,yaml]
 ----

modules/odc-creating-apiserversource.adoc

@@ -19,7 +19,7 @@
 
 .Verification steps
 
-. After you have created the ApiServerSource, you will see it connected to the service it is sinked to in the **Topology** view.
+* After you have created the ApiServerSource, you will see it connected to the service it is sinked to in the **Topology** view.
 +
 image::toplogy-odc-apiserver.png[ApiServerSource Topology view]
 

modules/serverless-about-collecting-data.adoc

@@ -6,9 +6,14 @@
 = About collecting {ServerlessProductName} data
 
 You can use the `oc adm must-gather` CLI command to collect information about your cluster, including features and objects associated with {ServerlessProductName}.
+To collect {ServerlessProductName} data with `must-gather`, you must specify the {ServerlessProductName} image.
 
-To collect {ServerlessProductName} data with `must-gather`, you must specify the {ServerlessProductName} image:
+.Procedure
 
+* Enter the command:
++
+
+[source,terminal]
 ----
 $ oc adm must-gather --image=registry.redhat.io/openshift-serverless-1/svls-must-gather-rhel8
 ----