You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Update Quarkus and Node.js quick starts to better describe manual connection use case (#537)
* Update quick starts to better describe the manual connection use case that they cover
* Minor tweaks
* Update links to relfect new titles
* SME feedback
Copy file name to clipboardexpand all lines: docs/kafka/getting-started-kafka/README.adoc
+6-6
Original file line number
Diff line number
Diff line change
@@ -345,12 +345,12 @@ endif::[]
345
345
[role="_additional-resources"]
346
346
== Additional resources
347
347
* https://console.redhat.com/application-services/streams/overview[Purchase a subscription to {product-long-kafka}]
348
-
* https://access.redhat.com/documentation/en-us/red_hat_openshift_streams_for_apache_kafka/1/guide/7d28aec8-e146-44db-a4a5-fafc1f426ca5[_Configuring topics in {product-long-kafka}_^]
349
-
* {base-url}{getting-started-rhoas-cli-url-kafka}[_Getting started with the `rhoas` CLI for {product-long-kafka}_^]
* {base-url}{kafkacat-url-kafka}[_Configuring and connecting Kafkacat with {product-long-kafka}_^]
352
-
* {base-url}{kafka-bin-scripts-url-kafka}[_Configuring and connecting Kafka scripts with {product-long-kafka}_^]
353
-
* {base-url}{quarkus-url-kafka}[_Using Quarkus applications with Kafka instances in {product-long-kafka}_^]
348
+
* https://access.redhat.com/documentation/en-us/red_hat_openshift_streams_for_apache_kafka/1/guide/7d28aec8-e146-44db-a4a5-fafc1f426ca5[Configuring topics in {product-long-kafka}^]
349
+
* {base-url}{getting-started-rhoas-cli-url-kafka}[Getting started with the rhoas CLI for {product-long-kafka}^]
Copy file name to clipboardexpand all lines: docs/kafka/nodejs-kafka/README.adoc
+9-7
Original file line number
Diff line number
Diff line change
@@ -74,14 +74,18 @@ END GENERATED ATTRIBUTES
74
74
////
75
75
76
76
[id="chap-using-nodejs"]
77
-
= Using Node.js applications with Kafka instances in {product-long-kafka}
77
+
= Manually connecting Node.js applications to Kafka instances in {product-long-kafka}
78
78
ifdef::context[:parent-context: {context}]
79
79
:context: using-nodejs
80
80
81
81
// Purpose statement for the assembly
82
82
[role="_abstract"]
83
83
As a developer of applications and services, you can connect Node.js applications to Kafka instances in {product-long-kafka}. https://nodejs.org/en/about/[Node.js^] is a server-side JavaScript runtime that is designed to build scalable network applications. Node.js provides an I/O model that is based on events and non-blocking operations, which enables efficient applications.
84
84
85
+
In this quick start, you'll use the {product-kafka} web console to collect connection information for a Kafka instance. Then you'll manually configure a connection to the Kafka instance from an example Node.js application and start producing and consuming messages.
86
+
87
+
NOTE: When you've completed this quick start and understand the required connection configuration for a Kafka instance, you can use the {product-long-rhoas} command-line interface (CLI) to generate this type of configuration in a more automated way. To learn more, see {base-url}{service-contexts-url-cli}[Connecting client applications to {product-long-rhoas} using the rhoas CLI^].
88
+
85
89
.Prerequisites
86
90
ifndef::community[]
87
91
* You have a Red Hat account.
@@ -91,22 +95,20 @@ endif::[]
91
95
* You have an IDE such as https://www.jetbrains.com/idea/download/[IntelliJ IDEA^], https://www.eclipse.org/downloads/[Eclipse^], or https://code.visualstudio.com/Download[VSCode^].
92
96
* https://nodejs.org/en/download/[Node.js 14^] is installed. The https://github.com/blizzard/node-rdkafka[node-rdkafka^] client can't run on later versions.
93
97
94
-
[NOTE]
95
-
====
96
-
The example Node.js application in this quick start uses the https://kafka.js.org/[KafkaJS^] client by default. If you want to use the https://github.com/blizzard/node-rdkafka[node-rdkafka^] client, you must install some development tools locally on your computer, or use Docker to run a specified container image and configure a development environment. To learn more, see the https://github.com/nodeshift-starters/reactive-example/tree/node-rdkafka#node-rdkafka-and-kafkajs[documentation] for the example Node.js application.
97
-
====
98
+
NOTE: The example Node.js application in this quick start uses the https://kafka.js.org/[KafkaJS^] client by default. If you want to use the https://github.com/blizzard/node-rdkafka[node-rdkafka^] client, you must install some development tools locally on your computer or use a container runtime such as Podman or Docker to run a specified container image and configure a development environment. To learn more, see the https://github.com/nodeshift-starters/reactive-example/tree/node-rdkafka#node-rdkafka-and-kafkajs[documentation] for the example Node.js application.
99
+
98
100
99
101
// Condition out QS-only content so that it doesn't appear in docs.
100
102
// All QS anchor IDs must be in this alternate anchor ID format `[#anchor-id]` because the ascii splitter relies on the other format `[id="anchor-id"]` to generate module files.
101
103
ifdef::qs[]
102
104
[#description]
103
105
====
104
-
Learn how to use Node.js applications to produce and consume messages using a Kafka instance in {product-long-kafka}.
106
+
Learn how to manually connect a Node.js application to a Kafka instance in {product-long-kafka} and then produce and consume messages.
105
107
====
106
108
107
109
[#introduction]
108
110
====
109
-
Welcome to the quick start for {product-long-kafka} with Node.js. In this quick start, you'll learn how to use the https://nodejs.org/en/about/[Node.js^] runtime to produce messages to and consume messages from your Kafka instances in {product-kafka}.
111
+
Welcome to the quick start for {product-long-kafka} with Node.js. In this quick start, you'll use the web console to collect connection information for a Kafka instance in {product-kafka}. Then you'll manually configure a connection to the Kafka instance from an example https://nodejs.org/en/about/[Node.js^] application and start producing and consuming messages.
Copy file name to clipboardexpand all lines: docs/kafka/quarkus-kafka/README.adoc
+9-5
Original file line number
Diff line number
Diff line change
@@ -74,14 +74,18 @@ END GENERATED ATTRIBUTES
74
74
////
75
75
76
76
[id="chap-using-quarkus"]
77
-
= Using Quarkus applications with Kafka instances in {product-long-kafka}
77
+
= Manually connecting Quarkus applications to Kafka instances in {product-long-kafka}
78
78
ifdef::context[:parent-context: {context}]
79
79
:context: using-quarkus
80
80
81
81
// Purpose statement for the assembly
82
82
[role="_abstract"]
83
83
As a developer of applications and services, you can connect Quarkus applications to Kafka instances in {product-long-kafka}. https://quarkus.io/[Quarkus^] is a Kubernetes-native Java framework made for Java virtual machines (JVMs) and native compilation, and optimized for serverless, cloud, and Kubernetes environments. Quarkus is designed to work with popular Java standards, frameworks, and libraries like Eclipse MicroProfile and Spring, as well as Apache Kafka, RESTEasy (JAX-RS), Hibernate ORM (JPA), Infinispan, Camel, and many more.
84
84
85
+
In this quick start, you'll use the {product-kafka} web console to collect connection information for a Kafka instance. Then you'll manually configure a connection to the Kafka instance from an example Quarkus application and start producing and consuming messages.
86
+
87
+
NOTE: When you've completed this quick start and understand the required connection configuration for a Kafka instance, you can use the {product-long-rhoas} command-line interface (CLI) to generate this type of configuration in a more automated way. To learn more, see {base-url}{service-contexts-url-cli}[Connecting client applications to {product-long-rhoas} using the rhoas CLI^].
88
+
85
89
.Prerequisites
86
90
ifndef::community[]
87
91
* You have a Red Hat account.
@@ -97,20 +101,20 @@ endif::[]
97
101
ifdef::qs[]
98
102
[#description]
99
103
====
100
-
Learn how to use Quarkus applications to produce messages to and consume messages from a Kafka instance in {product-long-kafka}.
104
+
Learn how to manually connect a Quarkus application to a Kafka instance in {product-long-kafka} and then produce and consume messages.
101
105
====
102
106
103
107
[#introduction]
104
108
====
105
-
Welcome to the quick start for {product-long-kafka} with Quarkus. In this quick start, you'll learn how to use https://quarkus.io/[Quarkus^] to produce messages to and consume messages from your Kafka instances in {product-kafka}.
109
+
Welcome to the quick start for {product-long-kafka} with Quarkus. In this quick start, you'll use the web console to collect connection information for a Kafka instance in {product-kafka}. Then you'll manually configure a connection to the Kafka instance from an example https://quarkus.io/[Quarkus^] application and start producing and consuming messages.
For this quick start, you'll use the Quarkus sample code from the {product-kafka} {samples-git-repo}[Guides and Samples^] repository in GitHub. After you understand the concepts and tasks in this quick start, you can use your own Quarkus applications with {product-kafka} in the same way.
117
+
For this quick start, you'll use the Quarkus sample code from the {product-kafka} {samples-git-repo}[Guides and Samples^] repository in GitHub.
114
118
115
119
.Procedure
116
120
. On the command line, clone the {product-kafka} {samples-git-repo}[Guides and Samples^] repository from GitHub.
@@ -238,7 +242,7 @@ endif::[]
238
242
ifdef::qs[]
239
243
[#conclusion]
240
244
====
241
-
Congratulations! You successfully completed the {product-kafka} Quarkus quick start, and are now ready to use your own Quarkus applications with {product-kafka}.
245
+
Congratulations! You successfully completed the {product-kafka} Quarkus quick start, and are now ready to connect your own Quarkus applications to {product-kafka}.
0 commit comments