SRVCOM-1288 + SRVCOM-1664: Clean up attributes, prereqs

abrennan89 · abrennan89 · commit 99bedbc4b368 · 2022-02-11T16:29:50.000-06:00
diff --git a/images/add-trigger-odc.png b/images/add-trigger-odc.png
diff --git a/images/delete-trigger-odc.png b/images/delete-trigger-odc.png
diff --git a/images/verify-trigger-odc.png b/images/verify-trigger-odc.png
diff --git a/modules/delete-kn-trigger.adoc b/modules/delete-kn-trigger.adoc
@@ -1,3 +1,7 @@
+// Module included in the following assemblies:
+//
+// * /serverless/develop/serverless-triggers.adoc
+
 :_content-type: PROCEDURE
 [id="delete-kn-trigger_{context}"]
 = Deleting a trigger by using the Knative CLI
@@ -8,6 +12,7 @@ You can use the `kn trigger delete` command to delete a trigger.
 
 * The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
 * You have installed the `kn` CLI.
+* You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
 
 .Procedure
 
diff --git a/modules/kn-trigger-describe.adoc b/modules/kn-trigger-describe.adoc
@@ -1,3 +1,7 @@
+// Module included in the following assemblies:
+//
+// * /serverless/develop/serverless-triggers.adoc
+
 :_content-type: PROCEDURE
 [id="kn-trigger-describe_{context}"]
 = Describing a trigger by using the Knative CLI
@@ -8,6 +12,7 @@ You can use the `kn trigger describe` command to print information about a trigg
 
 * The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
 * You have installed the `kn` CLI.
+* You have created a trigger.
 
 .Procedure
 
diff --git a/modules/kn-trigger-filtering.adoc b/modules/kn-trigger-filtering.adoc
@@ -1,14 +1,19 @@
+// Module included in the following assemblies:
+//
+// * /serverless/develop/serverless-triggers.adoc
+
+:_content-type: REFERENCE
 [id="kn-trigger-filtering_{context}"]
 = Filtering events with triggers by using the Knative CLI
 
-In the following trigger example, only events with the attribute `type: dev.knative.samples.helloworld` will reach the event sink.
+In the following trigger example, only events with the attribute `type: dev.knative.samples.helloworld` are sent to the event sink:
 
 [source,terminal]
 ----
 $ kn trigger create <trigger_name> --broker <broker_name> --filter type=dev.knative.samples.helloworld --sink ksvc:<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.
+You can also filter events by using multiple attributes. The following example shows how to filter events using the type, source, and extension attributes:
 
 [source,terminal]
 ----
diff --git a/modules/kn-trigger-list.adoc b/modules/kn-trigger-list.adoc
@@ -1,3 +1,7 @@
+// Module included in the following assemblies:
+//
+// * /serverless/develop/serverless-triggers.adoc
+
 :_content-type: PROCEDURE
 [id="kn-trigger-list_{context}"]
 = Listing triggers by using the Knative CLI
diff --git a/modules/kn-trigger-update.adoc b/modules/kn-trigger-update.adoc
@@ -1,3 +1,7 @@
+// Module included in the following assemblies:
+//
+// * /serverless/develop/serverless-triggers.adoc
+
 :_content-type: PROCEDURE
 [id="kn-trigger-update_{context}"]
 = Updating a trigger by using the Knative CLI
@@ -8,6 +12,7 @@ You can use the `kn trigger update` command with certain flags to update attribu
 
 * The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
 * You have installed the `kn` CLI.
+* You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
 
 .Procedure
 
diff --git a/modules/serverless-broker-types.adoc b/modules/serverless-broker-types.adoc
@@ -1,3 +1,8 @@
+// Module included in the following assemblies:
+//
+// * /serverless/develop/serverless-using-brokers.adoc
+
+:_content-type: CONCEPT
 [id="serverless-broker-types_{context}"]
 = Broker types
 
diff --git a/modules/serverless-create-broker-kn.adoc b/modules/serverless-create-broker-kn.adoc
@@ -1,3 +1,7 @@
+// Module included in the following assemblies:
+//
+// * /serverless/develop/serverless-using-brokers.adoc
+
 :_content-type: PROCEDURE
 [id="serverless-create-broker-kn_{context}"]
 = Creating a broker by using the Knative CLI
@@ -6,6 +10,7 @@
 
 * The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
 * You have installed the `kn` CLI.
+* You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
 
 .Procedure
 
diff --git a/modules/serverless-create-kafka-channel-yaml.adoc b/modules/serverless-create-kafka-channel-yaml.adoc
@@ -14,6 +14,7 @@ You can create a Kafka channel by using YAML to create the `KafkaChannel` object
 * The {ServerlessOperatorName}, Knative Eventing, and the `KnativeKafka` custom resource are installed on your {product-title} cluster.
 * You have installed the `oc` CLI.
 * You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
+* You have installed the `oc` CLI.
 
 .Procedure
 
diff --git a/modules/serverless-create-kn-trigger.adoc b/modules/serverless-create-kn-trigger.adoc
@@ -1,3 +1,7 @@
+// Module included in the following assemblies:
+//
+// * /serverless/develop/serverless-triggers.adoc
+
 :_content-type: PROCEDURE
 [id="serverless-create-kn-trigger_{context}"]
 = Creating a trigger by using the Knative CLI
@@ -8,6 +12,7 @@ You can create a trigger by using the `kn trigger create` command.
 
 * The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
 * You have installed the `kn` CLI.
+* You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
 
 .Procedure
 
diff --git a/modules/serverless-create-trigger-odc.adoc b/modules/serverless-create-trigger-odc.adoc
@@ -1,33 +1,34 @@
 // Module included in the following assemblies:
 //
-// * /serverless/knative_eventing/serverless-using-brokers.adoc
+// * /serverless/develop/serverless-triggers.adoc
 
 :_content-type: PROCEDURE
 [id="serverless-create-trigger-odc_{context}"]
-= Creating a trigger using the Developer perspective
+= Creating a trigger by using the web console
 
-After you have created a broker, you can create a trigger in the web console *Developer* perspective.
+After you have created a broker, you can create a trigger by using the web console.
 
 .Prerequisites
 
 * The {ServerlessOperatorName}, Knative Serving, and Knative Eventing are installed on your {product-title} cluster.
 * You have logged in to the web console.
-* You are in the *Developer* perspective.
 * You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
 * You have created a broker and a Knative service or other event sink to connect to the trigger.
 
 .Procedure
 
 . In the *Developer* perspective, navigate to the *Topology* page.
 . Hover over the broker that you want to create a trigger for, and drag the arrow. The *Add Trigger* option is displayed.
-+
-image::add-trigger-odc.png[Create a trigger for the broker]
 . Click *Add Trigger*.
 . Select your sink as a *Subscriber* from the drop-down list.
-+
 . Click *Add*.
 
 .Verification
-* After the subscription has been created, it is represented as a line that connects the broker to the service in the *Topology* view:
-+
-image::verify-trigger-odc.png[Trigger in the Topology view]
+
+* After the subscription has been created, you can view it in the *Topology* page, where it is represented as a line that connects the broker to the event sink.
+
+.Deleting a trigger
+
+. In the *Developer* perspective, navigate to the *Topology* page.
+. Click on the trigger that you want to delete.
+. In the *Actions* context menu, select *Delete Trigger*.
diff --git a/modules/serverless-creating-broker-annotation.adoc b/modules/serverless-creating-broker-annotation.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * serverless/knative_eventing/serverless-using-brokers.adoc
+// * /serverless/develop/serverless-using-brokers.adoc
 
 :_content-type: PROCEDURE
 [id="serverless-creating-broker-annotation_{context}"]
@@ -18,6 +18,7 @@ If you delete the broker without having a cluster administrator remove this anno
 
 * The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
 * You have installed the `oc` CLI.
+* You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
 
 .Procedure
 
diff --git a/modules/serverless-creating-broker-labeling.adoc b/modules/serverless-creating-broker-labeling.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * serverless/knative_eventing/serverless-using-brokers.adoc
+// * /serverless/develop/serverless-using-brokers.adoc
 
 :_content-type: PROCEDURE
 [id="serverless-creating-broker-labeling_{context}"]
@@ -10,12 +10,14 @@ You can create the `default` broker automatically by labeling a namespace that y
 
 [NOTE]
 ====
-Brokers created using this method will not be removed if you remove the label. You must manually delete them.
+Brokers created using this method are not removed if you remove the label. You must manually delete them.
 ====
 
 .Prerequisites
 
 * The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
+* You have installed the `oc` CLI.
+* You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
 
 .Procedure
 
diff --git a/modules/serverless-delete-trigger-odc.adoc b/modules/serverless-delete-trigger-odc.adoc
diff --git a/modules/serverless-deleting-broker-injection.adoc b/modules/serverless-deleting-broker-injection.adoc
@@ -1,12 +1,12 @@
 // Module included in the following assemblies:
 //
-// * serverless/knative_eventing/serverless-using-brokers.adoc
+// * /serverless/develop/serverless-using-brokers.adoc
 
 :_content-type: PROCEDURE
 [id="serverless-deleting-broker-injection_{context}"]
 = Deleting a broker that was created by injection
 
-Brokers created by injection, by using a namespace label or trigger annotation, are not deleted permanently if a developer removes the label or annotation. You must manually delete these brokers.
+If you create a broker by injection and later want to delete it, you must delete it manually. Brokers created by using a namespace label or trigger annotation are not deleted permanently if you remove the label or annotation.
 
 .Procedure
 
diff --git a/modules/serverless-describe-broker-kn.adoc b/modules/serverless-describe-broker-kn.adoc
@@ -1,10 +1,14 @@
+// Module included in the following assemblies:
+//
+// * /serverless/develop/serverless-using-brokers.adoc
+
 :_content-type: PROCEDURE
 [id="serverless-describe-broker-kn_{context}"]
 = Describing an existing broker by using the Knative CLI
 
 .Prerequisites
 
-* The {ServerlessOperatorName}, Knative Serving and Knative Eventing are installed on your {product-title} cluster.
+* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
 * You have installed the `kn` CLI.
 
 .Procedure
diff --git a/modules/serverless-kafka-broker.adoc b/modules/serverless-kafka-broker.adoc
@@ -5,11 +5,15 @@
 
 :_content-type: PROCEDURE
 [id="serverless-kafka-broker_{context}"]
-= Creating a Kafka broker
+= Creating a Kafka broker by using YAML
+
+You can create a Kafka broker by using YAML files.
 
 .Prerequisites
 
 * The {ServerlessOperatorName}, Knative Eventing, and the `KnativeKafka` custom resource are installed on your {product-title} cluster.
+* You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
+* You have installed the `oc` CLI.
 
 .Procedure
 
diff --git a/modules/serverless-kafka-event-delivery.adoc b/modules/serverless-kafka-event-delivery.adoc
@@ -2,6 +2,7 @@
 //
 // * serverless/develop/serverless-kafka-developer.adoc
 
+:_content-type: CONCEPT
 [id="serverless-kafka-delivery-retries_{context}"]
 = Kafka event delivery and retries
 
diff --git a/modules/serverless-kafka-source-kn.adoc b/modules/serverless-kafka-source-kn.adoc
@@ -13,6 +13,7 @@ This section describes how to create a Kafka event source by using the `kn` comm
 * The {ServerlessOperatorName}, Knative Eventing, Knative Serving, and the `KnativeKafka` custom resource (CR) are installed on your cluster.
 * You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
 * You have access to a Red Hat AMQ Streams (Kafka) cluster that produces the Kafka messages you want to import.
+* You have installed the `kn` CLI.
 
 .Procedure
 
diff --git a/modules/serverless-kafka-source-odc.adoc b/modules/serverless-kafka-source-odc.adoc
@@ -12,12 +12,12 @@ You can create and verify a Kafka event source from the {product-title} web cons
 
 * The {ServerlessOperatorName}, Knative Eventing, and the `KnativeKafka` custom resource are installed on your cluster.
 * You have logged in to the web console.
-* You are in the *Developer* perspective.
+* You have access to a Red Hat AMQ Streams (Kafka) cluster that produces the Kafka messages you want to import.
 * You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
 
 .Procedure
 
-. Navigate to the *Add* page and select *Event Source*.
+. In the *Developer* perspective, navigate to the *Add* page and select *Event Source*.
 . In the *Event Sources* page, select *Kafka Source* in the *Type* section.
 . Configure the *Kafka Source* settings:
 .. Add a comma-separated list of *Bootstrap Servers*.
diff --git a/modules/serverless-kafka-source-yaml.adoc b/modules/serverless-kafka-source-yaml.adoc
@@ -12,6 +12,8 @@ You can create a Kafka event source by using YAML.
 
 * The {ServerlessOperatorName}, Knative Eventing, and the `KnativeKafka` custom resource are installed on your cluster.
 * You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
+* You have access to a Red Hat AMQ Streams (Kafka) cluster that produces the Kafka messages you want to import.
+* You have installed the `oc` CLI.
 
 .Procedure
 
diff --git a/modules/serverless-list-broker-kn.adoc b/modules/serverless-list-broker-kn.adoc
@@ -1,10 +1,14 @@
+// Module included in the following assemblies:
+//
+// * /serverless/develop/serverless-using-brokers.adoc
+
 :_content-type: PROCEDURE
 [id="serverless-list-broker-kn_{context}"]
 = Listing existing brokers by using the Knative CLI
 
 .Prerequisites
 
-* The {ServerlessOperatorName}, Knative Serving and Knative Eventing are installed on your {product-title} cluster.
+* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
 * You have installed the `kn` CLI.
 
 .Procedure
diff --git a/modules/specifying-sink-flag-kn.adoc b/modules/specifying-sink-flag-kn.adoc
@@ -3,6 +3,7 @@
 // * /serverless/develop/serverless-event-sinks.adoc
 // * serverless/develop/serverless-apiserversource.adoc
 // * /serverless/develop/serverless-custom-event-sources.adoc
+// * serverless/develop/serverless-kafka-developer.adoc
 
 :_content-type: REFERENCE
 [id="specifying-sink-flag-kn_{context}"]
diff --git a/serverless/develop/serverless-triggers.adoc b/serverless/develop/serverless-triggers.adoc
@@ -1,6 +1,6 @@
 :_content-type: ASSEMBLY
 [id="serverless-triggers"]
-= Filtering events from a broker by using triggers
+= Triggers
 include::modules/common-attributes.adoc[]
 include::modules/serverless-document-attributes.adoc[]
 :context: serverless-triggers
@@ -9,17 +9,8 @@ toc::[]
 
 Using triggers enables you to filter events from the broker for delivery to event sinks.
 
-[id="prerequisites_serverless-triggers"]
-== Prerequisites
-
-* You have installed Knative Eventing and the `kn` CLI.
-* You have access to an available broker.
-* You have access to an available event consumer, such as a Knative service.
-
 // ODC
 include::modules/serverless-create-trigger-odc.adoc[leveloffset=+1]
-include::modules/serverless-delete-trigger-odc.adoc[leveloffset=+1]
-
 // kn trigger
 include::modules/serverless-create-kn-trigger.adoc[leveloffset=+1]
 include::modules/kn-trigger-list.adoc[leveloffset=+1]
