Skip to content

Commit da34347

Browse files
authored
docs: JX-328: Trims the long descriptions to avoid truncation (#630)
1 parent 32ac8cd commit da34347

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ endif::[]
107107
ifdef::qs[]
108108
[#description]
109109
====
110-
Learn how to configure connections between {product-long-kafka} and third-party systems by using {product-long-connectors}.
110+
Configure connections between an {product-kafka} instance and third-party systems.
111111
====
112112

113113
[#introduction]
@@ -116,7 +116,7 @@ Welcome to the quick start for {product-long-connectors}.
116116
117117
In this quick start, you learn how to create a source connector and sink connector and send data to and from {product-kafka}.
118118
119-
A _source_ connector allows you to send data from an external system to {product-kafka}.
119+
A _source_ connector allows you to send data from an external system to {product-kafka}.
120120
121121
A _sink_ connector allows you to send data from {product-kafka} to an external system.
122122
====
@@ -128,7 +128,7 @@ endif::[]
128128

129129
[role="_abstract"]
130130

131-
Before you use {product-connectors}, you must complete the following prerequisites:
131+
Before you use {product-connectors}, you must complete the following prerequisites:
132132

133133
* Determine which {openshift} environment to use for your _{connectors} namespace_. The {connectors} namespace is where your {product-connectors} instances are deployed.
134134

@@ -252,7 +252,7 @@ Click *Next*.
252252

253253
. Select one of the following error handling policies for your {connectors} instance:
254254
+
255-
* *Stop*: If a message fails to send, the {connectors} instance stops running and changes its status to the *Failed* state. You can view the error message.
255+
* *Stop*: If a message fails to send, the {connectors} instance stops running and changes its status to the *Failed* state. You can view the error message.
256256
* *Ignore*: If a message fails to send, the {connectors} instance ignores the error and continues to run. No error message is logged.
257257
* *Dead letter queue*: If a message fails to send, the {connectors} instance sends error details to the Kafka topic that you created for the DLQ.
258258
+

docs/kafka/nodejs-kafka/README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ NOTE: The example Node.js application in this quick start uses the https://kafka
116116
ifdef::qs[]
117117
[#description]
118118
====
119-
Learn how to manually connect a Node.js application to a Kafka instance in {product-long-kafka} and then produce and consume messages.
119+
Manually connect a Node.js application to a Kafka instance and then produce and consume messages.
120120
====
121121

122122
[#introduction]

docs/kafka/quarkus-kafka/README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ endif::[]
115115
ifdef::qs[]
116116
[#description]
117117
====
118-
Learn how to manually connect a Quarkus application to a Kafka instance in {product-long-kafka} and then produce and consume messages.
118+
Manually connect a Quarkus application to a Kafka instance and then produce and consume messages.
119119
====
120120

121121
[#introduction]

docs/registry/quarkus-registry/README.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ endif::[]
118118
ifdef::qs[]
119119
[#description]
120120
====
121-
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.
121+
Manually connect a Quarkus application to a Kafka instance and to a {registry} instance.
122122
====
123123

124124
[#introduction]
@@ -161,7 +161,7 @@ This Quarkus example application includes producer and consumer processes that s
161161

162162
.Prerequisites
163163
* You have a service account with write access to Kafka and {registry} instances and have stored your credentials securely (see {base-url}{getting-started-url-kafka}[Getting started with {product-long-kafka}^] and {base-url}{getting-started-url-registry}[Getting started with {product-long-registry}^]).
164-
* You have the bootstrap server endpoint for the Kafka instance. To get this information, select your Kafka instance in the {service-url-kafka}[{product-kafka} web console^], select the options icon (three vertical dots), and click *Connection*.
164+
* You have the bootstrap server endpoint for the Kafka instance. To get this information, select your Kafka instance in the {service-url-kafka}[{product-kafka} web console^], select the options icon (three vertical dots), and click *Connection*.
165165
* You have the Core Registry API endpoint for the {registry} instance. To get this information, select your {registry} instance in the {service-url-registry}[{product-registry} web console^], select the options icon (three vertical dots) and click *Connection*. Copy the *Core Registry API* endpoint supported by the Apicurio serializer/deserializer (SerDes) used in this example.
166166
* You have the SASL/OAUTHBEARER token endpoint used by the {registry} and Kafka instances. To get this information, select your {registry} instance in the {service-url-registry}[{product-registry} web console^], select the options icon (three vertical dots) and click *Connection*. Copy the *Token endpoint URL* value.
167167

0 commit comments

Comments
 (0)