Skip to content

Commit 5b4bc6e

Browse files
docs: Updates to Quarkus quick start for Service Registry to describe manual connection use case (#542)
* Updates to describe manual connection use case * Restore original titles of RHOSAK quick starts. Other minor tweaks.
1 parent 1477ed5 commit 5b4bc6e

File tree

5 files changed

+16
-14
lines changed

5 files changed

+16
-14
lines changed

README.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@
88

99
* link:./docs/kafka/getting-started-kafka[Getting started with {product-long-kafka}]
1010
* link:./docs/kafka/rhoas-cli-getting-started-kafka[Getting started with the rhoas CLI for {product-long-kafka}]
11-
* link:./docs/kafka/quarkus-kafka[Manually connecting Quarkus applications to Kafka instances in {product-long-kafka}]
11+
* link:./docs/kafka/quarkus-kafka[Using Quarkus applications with Kafka instances in {product-long-kafka}]
1212
* link:./docs/kafka/kcat-kafka[Configuring and connecting Kafkacat with {product-long-kafka}]
1313
* link:./docs/kafka/kafka-bin-scripts-kafka[Configuring and connecting Kafka scripts with {product-long-kafka}]
1414
* link:./docs/kafka/access-mgmt-kafka[Managing account access in {product-long-kafka}]
1515
* link:./docs/kafka/service-binding-kafka[Binding OpenShift applications to {product-long-kafka}]
1616
* link:./docs/kafka/topic-configuration-kafka[Configuring topics in {product-long-kafka}]
17-
* link:./docs/kafka/nodejs-kafka[Manually connecting Node.js applications to Kafka instances in {product-long-kafka}]
17+
* link:./docs/kafka/nodejs-kafka[Using Node.js applications with Kafka instances in {product-long-kafka}]
1818
* link:./docs/kafka/metrics-monitoring-kafka[Monitoring metrics in {product-long-kafka}]
1919
* link:./docs/kafka/consumer-configuration-kafka[Configuring consumer groups in {product-long-kafka}]
2020

docs/kafka/getting-started-kafka/README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ endif::[]
350350
* {base-url-cli}{command-ref-url-cli}[CLI command reference (rhoas)^]
351351
* {base-url}{kafkacat-url-kafka}[Configuring and connecting Kafkacat with {product-long-kafka}^]
352352
* {base-url}{kafka-bin-scripts-url-kafka}[Configuring and connecting Kafka scripts with {product-long-kafka}^]
353-
* {base-url}{quarkus-url-kafka}[Manually connecting Quarkus applications to Kafka instances in {product-long-kafka}^]
353+
* {base-url}{quarkus-url-kafka}[Using Quarkus applications with Kafka instances in {product-long-kafka}^]
354354

355355
ifdef::qs[]
356356
[#conclusion]

docs/kafka/nodejs-kafka/README.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,15 +74,15 @@ END GENERATED ATTRIBUTES
7474
////
7575

7676
[id="chap-using-nodejs"]
77-
= Manually connecting Node.js applications to Kafka instances in {product-long-kafka}
77+
= Using Node.js applications with Kafka instances in {product-long-kafka}
7878
ifdef::context[:parent-context: {context}]
7979
:context: using-nodejs
8080

8181
// Purpose statement for the assembly
8282
[role="_abstract"]
8383
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.
8484

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.
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 from an example Node.js application to the Kafka instance and start producing and consuming messages.
8686

8787
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^].
8888

@@ -108,7 +108,7 @@ Learn how to manually connect a Node.js application to a Kafka instance in {prod
108108

109109
[#introduction]
110110
====
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.
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 from an example https://nodejs.org/en/about/[Node.js^] application to the Kafka instance and start producing and consuming messages.
112112
====
113113
endif::[]
114114

docs/kafka/quarkus-kafka/README.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,15 +74,15 @@ END GENERATED ATTRIBUTES
7474
////
7575

7676
[id="chap-using-quarkus"]
77-
= Manually connecting Quarkus applications to Kafka instances in {product-long-kafka}
77+
= Using Quarkus applications with Kafka instances in {product-long-kafka}
7878
ifdef::context[:parent-context: {context}]
7979
:context: using-quarkus
8080

8181
// Purpose statement for the assembly
8282
[role="_abstract"]
8383
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.
8484

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.
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 from an example Quarkus application to the Kafka instance and start producing and consuming messages.
8686

8787
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^].
8888

@@ -106,7 +106,7 @@ Learn how to manually connect a Quarkus application to a Kafka instance in {prod
106106

107107
[#introduction]
108108
====
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.
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 from an example https://quarkus.io/[Quarkus^] application to the Kafka instance and start producing and consuming messages.
110110
====
111111
endif::[]
112112

docs/registry/quarkus-registry/README.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,13 @@ ifdef::context[:parent-context: {context}]
8080

8181
// Purpose statement for the assembly
8282
[role="_abstract"]
83-
As a developer of applications and services, you can connect Quarkus applications to Kafka instances in {product-long-kafka} and {registry} instances in {product-long-registry}. This makes it easy for development teams to store and reuse schemas in event streaming architectures.
83+
As a developer of applications and services, you can connect Quarkus applications to Kafka instances in {product-long-kafka} and {registry} instances in {product-long-registry}. This makes it easy for development teams to store and reuse schemas in event-streaming architectures.
8484

85-
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.
85+
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.
8686

87-
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.
87+
In this quick start, you'll manually configure connections from an example Quarkus application to Kafka and {registry} instances. The application will use the Kafka instance to produce and consume messages and a schema stored in the {registry} instance to serialize/deserialize the messages.
88+
89+
NOTE: When you've completed this quick start and understand the required connection configurations for Kafka and {registry} instances, you can use the {product-long-rhoas} command-line interface (CLI) to generate these types of configurations 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^].
8890

8991
.Prerequisites
9092
ifndef::community[]
@@ -102,12 +104,12 @@ endif::[]
102104
ifdef::qs[]
103105
[#description]
104106
====
105-
Learn how to use a Quarkus application that produces messages to and consume messages from a Kafka instance in {product-long-kafka} and manage the message schemas in {product-long-registry}.
107+
Learn how to manually connect a Quarkus application to a Kafka instance in {product-long-kafka} and a {registry} instance in {product-long-registry}. The application will use the Kafka instance to produce and consume messages and a schema stored in the {registry} instance to serialize/deserialize the messages.
106108
====
107109

108110
[#introduction]
109111
====
110-
Welcome to the quick start for {product-long-registry} 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} and manage the message schemas in {product-long-registry}.
112+
Welcome to the quick start for {product-long-registry} with Quarkus. In this quick start, you'll learn how to manually connect an example https://quarkus.io/[Quarkus^] application to a Kafka instance in {product-long-kafka} and a {registry} instance in {product-registry}. The application will use the Kafka instance to produce and consume messages and a schema stored in the {registry} instance to serialize/deserialize the messages.
111113
====
112114
endif::[]
113115

0 commit comments

Comments
 (0)