Add note to client guides about message browsing in console (#514)

jbyrne-redhat · web-flow · commit fbc2bfb31235 · 2022-05-23T21:01:02.000+01:00
* Add note to client guides about message browsing in console. New attribute required.

* Address peer review feedback
diff --git a/docs/_artifacts/document-attributes.adoc b/docs/_artifacts/document-attributes.adoc
@@ -33,6 +33,7 @@
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
diff --git a/docs/api-designer/getting-started-api-designer/README.adoc b/docs/api-designer/getting-started-api-designer/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
diff --git a/docs/connectors/getting-started-connectors/README.adoc b/docs/connectors/getting-started-connectors/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
diff --git a/docs/kafka/access-mgmt-kafka/README.adoc b/docs/kafka/access-mgmt-kafka/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
diff --git a/docs/kafka/consumer-configuration-kafka/README.adoc b/docs/kafka/consumer-configuration-kafka/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
diff --git a/docs/kafka/getting-started-kafka/README.adoc b/docs/kafka/getting-started-kafka/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
diff --git a/docs/kafka/kafka-bin-scripts-kafka/README.adoc b/docs/kafka/kafka-bin-scripts-kafka/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
@@ -252,6 +253,8 @@ The preceding example uses the SASL/PLAIN authentication mechanism with the cred
 
 . If your producer is still running in a separate terminal, continue entering messages in the producer terminal and observe the messages being consumed in the consumer terminal.
 
+NOTE: You can also use the {product-long-kafka} web console to browse messages in the Kafka topic. For more information, see {base-url}{message-browsing-url-kafka}[_Browsing messages in the {product-long-kafka} web console_^].
+
 .Verification
 ifdef::qs[]
 * Is the `kafka-console-consumer` script running without any errors in the terminal?
diff --git a/docs/kafka/kcat-kafka/README.adoc b/docs/kafka/kcat-kafka/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
@@ -237,6 +238,8 @@ Third message
 --
 . If your producer is still running in a separate terminal, continue entering messages in the producer terminal and observe the messages being consumed in the consumer terminal.
 
+NOTE: You can also use the {product-long-kafka} web console to browse messages in the Kafka topic. For more information, see {base-url}{message-browsing-url-kafka}[_Browsing messages in the {product-long-kafka} web console_^].
+
 .Verification
 ifdef::qs[]
 * Is your consumer running without any errors in the terminal?
diff --git a/docs/kafka/message-browsing-kafka/README.adoc b/docs/kafka/message-browsing-kafka/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
diff --git a/docs/kafka/metrics-monitoring-kafka/README.adoc b/docs/kafka/metrics-monitoring-kafka/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
diff --git a/docs/kafka/nodejs-kafka/README.adoc b/docs/kafka/nodejs-kafka/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
@@ -322,6 +323,8 @@ Haiti
 ----
 +
 The output from both components confirms that they successfully connected to the Kafka instance. The components are using the Kafka topic that you created to produce and consume messages.
++
+NOTE: You can also use the {product-long-kafka} web console to browse messages in the Kafka topic. For more information, see {base-url}{message-browsing-url-kafka}[_Browsing messages in the {product-long-kafka} web console_^].
 
 . In your IDE, in the `producer-backend` directory of the repository that you cloned, open the `producer.js` file.
 +
diff --git a/docs/kafka/quarkus-kafka/README.adoc b/docs/kafka/quarkus-kafka/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
@@ -217,6 +218,8 @@ $ ./mvnw quarkus:dev
 ----
 . After the application is running, in a web browser, go to http://localhost:8080/prices.html[^] and verify that the `Last price` is updated.
 +
+NOTE: You can also use the {product-long-kafka} web console to browse messages in the Kafka topic. For more information, see {base-url}{message-browsing-url-kafka}[_Browsing messages in the {product-long-kafka} web console_^].
++
 If the Quarkus application fails to run, review the error log in the terminal and address any problems. Also review the steps in this quick start to ensure that the Quarkus application and Kafka topic are configured correctly.
 
 ifdef::qs[]
diff --git a/docs/kafka/rhoas-cli-getting-started-kafka/README.adoc b/docs/kafka/rhoas-cli-getting-started-kafka/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
diff --git a/docs/kafka/service-binding-kafka/README.adoc b/docs/kafka/service-binding-kafka/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
@@ -540,6 +541,8 @@ When service binding is complete, OpenShift redeploys the Quarkus application. W
 . To verify that the Quarkus application is using the Kafka topic, reopen the *Last price* web page that you opened earlier in this tutorial.
 +
 On the *Last price* web page, observe that the price value is continuously updated. The updates show that the Quarkus application is now using the `prices` topic in your Kafka instance to produce and consume messages that correspond to price updates.
++
+NOTE: You can also use the {product-long-kafka} web console to browse messages in the Kafka topic. For more information, see {base-url}{message-browsing-url-kafka}[_Browsing messages in the {product-long-kafka} web console_^].
 
 [id="con-binding-nodejs-application-using-web-console_{context}"]
 == Binding a Node.js application to {product-long-kafka} using the OpenShift web console
@@ -752,3 +755,5 @@ You should now see that the producer has connected to the Kafka instance. The pr
 . Open the logs for the pod of the consumer component, in the same way that you did for the producer component.
 +
 You should now see that the consumer has connected to the Kafka instance. The consumer displays the same country names that the producer sends to the `countries` Kafka topic, and in the same order.
++
+NOTE: You can also use the {product-long-kafka} web console to browse messages in the Kafka topic. For more information, see {base-url}{message-browsing-url-kafka}[_Browsing messages in the {product-long-kafka} web console_^].
diff --git a/docs/kafka/topic-configuration-kafka/README.adoc b/docs/kafka/topic-configuration-kafka/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
diff --git a/docs/registry/access-mgmt-registry/README.adoc b/docs/registry/access-mgmt-registry/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
diff --git a/docs/registry/getting-started-registry/README.adoc b/docs/registry/getting-started-registry/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
diff --git a/docs/registry/quarkus-registry/README.adoc b/docs/registry/quarkus-registry/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
diff --git a/docs/registry/rhoas-cli-getting-started-registry/README.adoc b/docs/registry/rhoas-cli-getting-started-registry/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
diff --git a/docs/registry/service-binding-registry/README.adoc b/docs/registry/service-binding-registry/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
diff --git a/docs/rhoas/rhoas-cli-installation/README.adoc b/docs/rhoas/rhoas-cli-installation/README.adoc
@@ -33,6 +33,7 @@ WARNING: This content is generated by running npm --prefix .build run generate:a
 :access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc
 :metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc
 :service-binding-url-kafka: kafka/service-binding-kafka/README.adoc
+:message-browsing-url-kafka: kafka/message-browsing-kafka/README.adoc
 
 //OpenShift Service Registry
 :product-long-registry: OpenShift Service Registry
