Skip to content

Commit 38b5884

Browse files
docs: updates to ensure that console quick starts don't refer to figures (#606)
1 parent 4aec91a commit 38b5884

4 files changed

Lines changed: 42 additions & 29 deletions

File tree

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

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -129,11 +129,16 @@ endif::[]
129129
.Procedure
130130
. In the {product-kafka} {service-url-kafka}[web console^], select *Kafka Instances* and click *Create Kafka instance*.
131131
+
132+
ifdef::qs[]
133+
The instance creation pane opens.
134+
endif::[]
135+
ifndef::qs[]
132136
The instance creation pane opens, as shown in the figure.
133137
+
134138
[.screencapture]
135139
.Kafka instance creation pane
136140
image::sak-configure-kafka-instance.png[Image of Create Kafka instance pane]
141+
endif::[]
137142

138143
. Enter a unique name for the Kafka instance, such as `my-first-kafka-instance`.
139144
. In the *Cloud region* list, select the relevant option.
@@ -159,11 +164,15 @@ For more information about the support scope of Red Hat Technology Preview featu
159164
--
160165
The new Kafka instance is listed on the *Kafka Instances* page. Typically, you need to wait a few minutes for the instance creation process to finish.
161166

167+
ifdef::qs[]
168+
When the instance has a status of *Ready*, you can start using the instance. You can click the options icon (three vertical dots) to view instance and connection details, change the instance owner, or delete the instance.
169+
endif::[]
170+
ifndef::qs[]
162171
When the instance has a status of *Ready*, you can start using the instance. As shown in the following figure, you can click the options icon (three vertical dots) to view instance and connection details, change the instance owner, or delete the instance.
163-
164172
[.screencapture]
165173
.Kafka instance options menu
166174
image::sak-kafka-instance-options.png[Image of Kafka instance options menu]
175+
endif::[]
167176

168177
NOTE: Although you can see Kafka instances created by other users in your organization, you might not be able to manage or connect to those instances. Only the instance owner or users with permissions to access the instance can edit or delete the instance, access the associated service account and topics, or connect to the instance.
169178
--
@@ -307,13 +316,18 @@ After you create a Kafka instance, you can create Kafka topics to start producin
307316

308317
. In the {product-long-kafka} {service-url-kafka}[web console^], select *Kafka Instances* and then click the name of the Kafka instance that you want to add a topic to.
309318
. Select the *Topics* tab.
319+
ifdef::qs[]
320+
. Click *Create topic* and follow the guided steps to define the topic details.
321+
endif::[]
322+
ifndef::qs[]
310323
. Click *Create topic* and follow the guided steps to define the topic details, as shown in the figure.
311324
+
312-
--
313325
[.screencapture]
314326
.Guided steps to define topic details
315327
image::sak-create-topic.png[Image of wizard to create a topic]
316-
328+
endif::[]
329+
+
330+
--
317331
You must specify the following topic properties:
318332

319333
* *Topic name*: Enter a unique topic name, such as `my-first-kafka-topic`.
@@ -330,11 +344,12 @@ endif::[]
330344
NOTE: If the topic creation is unsuccessful and you see a `400 Bad Request` error message, try to create your topic again later. This situation might occur, for example, if your selected cloud provider has a temporary availability problem that affects your Kafka instance.
331345
--
332346

347+
ifdef::qs[]
348+
. (Optional) To edit or delete the topic, click the options icon (three vertical dots) next to the topic name.
349+
endif::[]
350+
ifndef::qs[]
333351
. (Optional) To edit or delete the topic, click the options icon (three vertical dots) next to the topic name, as shown in the figure.
334-
+
335-
[.screencapture]
336-
.Edit or delete Kafka topic
337-
image::sak-edit-topic.png[Image of topic options to edit or delete]
352+
endif::[]
338353

339354
.Verification
340355
ifdef::qs[]

docs/kafka/nodejs-kafka/README.adoc

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -205,20 +205,18 @@ The Node.js application in this quick start uses a Kafka topic called `countries
205205
.Procedure
206206
. In the {product-kafka} {service-url-kafka}[web console^], select *Kafka Instances* and then click the name of the Kafka instance that you want to add a topic to.
207207
. Select the *Topics* tab.
208-
. Click *Create topic* and follow the guided steps to define the topic details, as shown in the figure.
209-
+
210-
[.screencapture]
211-
.Guided steps to define topic details
212-
image::sak-create-countries-topic.png[Image of wizard to create a topic]
208+
. Click *Create topic* and follow the guided steps to define the topic details.
213209
+
210+
--
214211
You must specify the following topic properties:
215212

216-
* *Topic name*: Enter `countries` as the topic name.
217-
* *Partitions*: Set the number of partitions for this topic. This example sets the partitions value to `1`. Partitions are distinct lists of messages within a topic and enable parts of a topic to be distributed over multiple brokers in the cluster. A topic can contain one or more partitions, enabling producer and consumer loads to be scaled.
218-
* *Message retention*: Set the message retention time and size to the relevant value and increment. This example sets the retention time to `A week` and the retention size to `Unlimited`. Message retention time is the amount of time that messages are retained in a topic before they are deleted or compacted, depending on the cleanup policy. Retention size is the maximum total size of all log segments in a partition before they are deleted or compacted.
219-
* *Replicas*: Replicas are copies of partitions in a topic. For this release of {product-kafka}, the replica values are preconfigured. The number of partition replicas for the topic is set to `3` and the minimum number of follower replicas that must be in sync with a partition leader is set to `2`. For a trial Kafka instance, the number of replicas and the minimum in-sync replica factor are both set to `1`. Partition replicas are distributed over multiple brokers in the cluster to ensure topic availability if a broker fails. When a follower replica is in sync with a partition leader, the follower replica can become the new partition leader if needed.
220-
+
213+
* *Topic name*: For this quick start, enter `countries` as the topic name.
214+
* *Partitions*: Set the number of partitions for the topic. For this quick start, set the value to `1`.
215+
* *Message retention*: Set the message retention time and size. For this quick start, set the retention time to `A week` and the retention size to `Unlimited`.
216+
* *Replicas*: For this release of {product-kafka}, the replica values are preconfigured. The number of partition replicas for the topic is set to `3` and the minimum number of follower replicas that must be in sync with a partition leader is set to `2`. For a trial Kafka instance, the number of replicas and the minimum in-sync replica factor are both set to `1`.
217+
221218
After you complete the setup, the new topic appears on the *Topics* page. You can now run the Node.js application to start producing and consuming messages.
219+
--
222220

223221
.Verification
224222
ifdef::qs[]

docs/kafka/quarkus-kafka/README.adoc

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -189,20 +189,18 @@ The Quarkus application in this quick start uses a Kafka topic called `prices` t
189189
.Procedure
190190
. In the {product-kafka} {service-url-kafka}[web console^], select *Kafka Instances* and then click the name of the Kafka instance that you want to add a topic to.
191191
. Select the *Topics* tab.
192-
. Click *Create topic* and follow the guided steps to define the topic details, as shown in the figure.
193-
+
194-
[.screencapture]
195-
.Guided steps to define topic details
196-
image::sak-create-topic.png[Image of wizard to create a topic]
192+
. Click *Create topic* and follow the guided steps to define the topic details.
197193
+
194+
--
198195
You must specify the following topic properties:
199196

200-
* *Topic name*: Enter `prices` as the topic name.
201-
* *Partitions*: Set the number of partitions for this topic. This example sets the partitions value to `1`. Partitions are distinct lists of messages within a topic and enable parts of a topic to be distributed over multiple brokers in the cluster. A topic can contain one or more partitions, enabling producer and consumer loads to be scaled.
202-
* *Message retention*: Set the message retention time and size to the relevant value and increment. This example sets the retention time to `A week` and the retention size to `Unlimited`. Message retention time is the amount of time that messages are retained in a topic before they are deleted or compacted, depending on the cleanup policy. Retention size is the maximum total size of all log segments in a partition before they are deleted or compacted.
203-
* *Replicas*: Replicas are copies of partitions in a topic. For this release of {product-kafka}, the replica values are preconfigured. The number of partition replicas for the topic is set to `3` and the minimum number of follower replicas that must be in sync with a partition leader is set to `2`. For a trial Kafka instance, the number of replicas and the minimum in-sync replica factor are both set to `1`. Partition replicas are distributed over multiple brokers in the cluster to ensure topic availability if a broker fails. When a follower replica is in sync with a partition leader, the follower replica can become the new partition leader if needed.
204-
+
197+
* *Topic name*: For this quick start, enter `prices` as the topic name.
198+
* *Partitions*: Set the number of partitions for the topic. For this quick start, set the value to `1`.
199+
* *Message retention*: Set the message retention time and size. For this quick start, set the retention time to `A week` and the retention size to `Unlimited`.
200+
* *Replicas*: For this release of {product-kafka}, the replica values are preconfigured. The number of partition replicas for the topic is set to `3` and the minimum number of follower replicas that must be in sync with a partition leader is set to `2`. For a trial Kafka instance, the number of replicas and the minimum in-sync replica factor are both set to `1`.
201+
205202
After you complete the setup, the new topic appears on the *Topics* page. You can now run the Quarkus application to start producing and consuming messages to and from this topic.
203+
--
206204

207205
.Verification
208206
ifdef::qs[]

docs/rhoas/rhoas-produce-consume/README.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,14 +128,16 @@ In this task, you'll create a new topic in your Kafka instance. You'll use this
128128
. Select the *Topics* tab.
129129
. Click *Create topic* and follow the guided steps to define the topic details.
130130
+
131+
--
131132
You must specify the following topic properties:
132133

133134
* *Topic name*: For this quick start, enter `test-topic` as the topic name.
134135
* *Partitions*: Set the number of partitions for the topic. For this quick start, set the value to `2`.
135136
* *Message retention*: Set the message retention time and size. For this quick start, set the retention time to `A week` and the retention size to `Unlimited`.
136-
* *Replicas*: For this release of {product-kafka}, replica values are preconfigured. The number of partition replicas and the minimum number of follower replicas that must be in sync with a partition leader are both set to `1`.
137-
+
137+
* *Replicas*: For this release of {product-kafka}, replica values are preconfigured. The number of partition replicas for the topic is set to `3` and the minimum number of follower replicas that must be in sync with a partition leader is set to `2`. For a trial Kafka instance, the number of replicas and the minimum in-sync replica factor are both set to `1`.
138+
138139
After you complete the setup, the new topic appears on the *Topics* page.
140+
--
139141

140142
.Verification
141143
ifdef::qs[]

0 commit comments

Comments
 (0)