Formatted asciidoc

Author: Julien Ruaux

src/docs/asciidoc/_connect.adoc

@@ -14,7 +14,8 @@ redis.uri=redis://redis-12000.redis.com:12000
 
 Details on the https://github.com/lettuce-io/lettuce-core/wiki/Redis-URI-and-connection-details#uri-syntax[Redis URI syntax] can be found in the Lettuce project https://github.com/lettuce-io/lettuce-core/wiki[wiki].
 
-TLS connection URIs start with `rediss://`. To disable certificate verification for TLS connections use the following property:
+TLS connection URIs start with `rediss://`.
+To disable certificate verification for TLS connections use the following property:
 
 [source,properties]
 ----

src/docs/asciidoc/_sink.adoc

@@ -20,7 +20,8 @@ The {name} guarantees that records from the Kafka topic are delivered at least o
 [[sink-tasks]]
 === Multiples tasks
 
-The {name} supports running one or more tasks. You can specify the number of tasks with the `tasks.max` configuration property.
+The {name} supports running one or more tasks.
+You can specify the number of tasks with the `tasks.max` configuration property.
 
 [[data-structures]]
 === Redis Data Structures
@@ -60,7 +61,8 @@ value.converter=<Avro or JSON> <2>
 ----
 
 <1> <<key-string,String>> or <<key-bytes,bytes>>
-<2> <<avro,Avro>> or <<kafka-json,JSON>>. If value is null the key is https://redis.io/commands/del[deleted].
+<2> <<avro,Avro>> or <<kafka-json,JSON>>.
+If value is null the key is https://redis.io/commands/del[deleted].
 
 ==== String
 Use the following properties to write Kafka records as Redis strings:
@@ -73,7 +75,8 @@ value.converter=<string or bytes> <2>
 ----
 
 <1> <<key-string,String>> or <<key-bytes,bytes>>
-<2> <<value-string,String>> or <<value-bytes,bytes>>. If value is null the key is https://redis.io/commands/del[deleted].
+<2> <<value-string,String>> or <<value-bytes,bytes>>.
+If value is null the key is https://redis.io/commands/del[deleted].
 
 ==== List
 Use the following properties to add Kafka record keys to a Redis list:
@@ -90,7 +93,8 @@ redis.push.direction=<LEFT or RIGHT> <3>
 <2> <<key-string,String>> or <<key-bytes,bytes>>: Kafka record keys to push to the list
 <3> `LEFT`: LPUSH (default), `RIGHT`: RPUSH
 
-The Kafka record value can be any format. If a value is null then the member is removed from the list (instead of pushed to the list).
+The Kafka record value can be any format.
+If a value is null then the member is removed from the list (instead of pushed to the list).
 
 ==== Set
 Use the following properties to add Kafka record keys to a Redis set:
@@ -105,7 +109,8 @@ key.converter=<string or bytes> <2>
 <1> <<collection-key,Set key>>
 <2> <<key-string,String>> or <<key-bytes,bytes>>: Kafka record keys to add to the set
 
-The Kafka record value can be any format. If a value is null then the member is removed from the set (instead of added to the set).
+The Kafka record value can be any format.
+If a value is null then the member is removed from the set (instead of added to the set).
 
 ==== Sorted Set
 Use the following properties to add Kafka record keys to a Redis sorted set:
@@ -120,7 +125,8 @@ key.converter=<string or bytes> <2>
 <1> <<collection-key,Sorted set key>>
 <2> <<key-string,String>> or <<key-bytes,bytes>>: Kafka record keys to add to the set
 
-The Kafka record value should be `float64` and is used for the score. If the score is null then the member is removed from the sorted set (instead of added to the sorted set).
+The Kafka record value should be `float64` and is used for the score.
+If the score is null then the member is removed from the sorted set (instead of added to the sorted set).
 
 [[redisjson]]
 ==== JSON
@@ -134,7 +140,8 @@ value.converter=<string or bytes> <2>
 ----
 
 <1> <<key-string,String>> or <<key-bytes,bytes>>
-<2> <<value-string,String>> or <<value-bytes,bytes>>. If value is null the key is https://redis.io/commands/del[deleted].
+<2> <<value-string,String>> or <<value-bytes,bytes>>.
+If value is null the key is https://redis.io/commands/del[deleted].
 
 ==== TimeSeries
 
@@ -193,7 +200,9 @@ key.converter=org.apache.kafka.connect.converters.ByteArrayConverter
 ----
 
 ==== Kafka Record Values
-Multiple data formats are supported for Kafka record values depending on the configured target <<data-structures,Redis data structure>>. Each data structure expects a specific format. If your data in Kafka is not in the format expected for a given data structure, consider using https://docs.confluent.io/platform/current/connect/transforms/overview.html[Single Message Transformations] to convert to a byte array, string, Struct, or map before it is written to Redis.
+Multiple data formats are supported for Kafka record values depending on the configured target <<data-structures,Redis data structure>>.
+Each data structure expects a specific format.
+If your data in Kafka is not in the format expected for a given data structure, consider using https://docs.confluent.io/platform/current/connect/transforms/overview.html[Single Message Transformations] to convert to a byte array, string, Struct, or map before it is written to Redis.
 
 [options="header",cols="h,1,1"]
 |====

src/docs/asciidoc/_source.adoc

@@ -18,12 +18,15 @@ The {name} guarantees that records from the Kafka topic are delivered at least o
 
 [[source-tasks]]
 === Multiple Tasks
-Use configuration property `tasks.max` to have the change stream handled by multiple tasks. The connector splits the work based on the number of configured key patterns. When the number of tasks is greater than the number of patterns, the number of patterns will be used instead.
+Use configuration property `tasks.max` to have the change stream handled by multiple tasks.
+The connector splits the work based on the number of configured key patterns.
+When the number of tasks is greater than the number of patterns, the number of patterns will be used instead.
 
 //
 //[[key-reader]]
 //=== Key Reader
-//In key reader mode, the {name} captures changes happening to keys in a Redis database and publishes keys and values to a Kafka topic. The data structure key will be mapped to the record key, and the value will be mapped to the record value.
+//In key reader mode, the {name} captures changes happening to keys in a Redis database and publishes keys and values to a Kafka topic.
+//The data structure key will be mapped to the record key, and the value will be mapped to the record value.
 //
 //[IMPORTANT]
 //.Supported Data Structures
@@ -41,12 +44,15 @@ Use configuration property `tasks.max` to have the change stream handled by mult
 //topic=<topic> <2>
 //----
 //
-//<1> Key portion of the pattern that will be used to listen to keyspace events. For example `foo:*` translates to pubsub channel `$$__$$keyspace@0$$__$$:foo:*` and will capture changes to keys `foo:1`, `foo:2`, etc. Use comma-separated values for multiple patterns (`foo:*,bar:*`)
+//<1> Key portion of the pattern that will be used to listen to keyspace events.
+For example `foo:*` translates to pubsub channel `$$__$$keyspace@0$$__$$:foo:*` and will capture changes to keys `foo:1`, `foo:2`, etc.
+Use comma-separated values for multiple patterns (`foo:*,bar:*`)
 //<2> Name of the destination topic.
 
 [[stream-reader]]
 === Stream Reader
-The {name} reads messages from a stream and publishes to a Kafka topic. Reading is done through a consumer group so that <<source-tasks,multiple instances>> of the connector configured via the `tasks.max` can consume messages in a round-robin fashion.
+The {name} reads messages from a stream and publishes to a Kafka topic.
+Reading is done through a consumer group so that <<source-tasks,multiple instances>> of the connector configured via the `tasks.max` can consume messages in a round-robin fashion.
 
 
 ==== Stream Message Schema
@@ -83,5 +89,9 @@ topic=<name> <6>
 <2> https://redis.io/commands/xread#incomplete-ids[Message ID] to start reading from (default: `0-0`).
 <3> Maximum https://redis.io/commands/xread[XREAD] wait duration in milliseconds (default: `100`).
 <4> Name of the stream consumer group (default: `kafka-consumer-group`).
-<5> Name of the stream consumer (default: `consumer-${task}`). May contain `${task}` as a placeholder for the task id. For example, `foo${task}` and task `123` => consumer `foo123`.
-<6> Destination topic (default: `${stream}`). May contain `${stream}` as a placeholder for the originating stream name. For example, `redis_${stream}` and stream `orders` => topic `redis_orders`.
+<5> Name of the stream consumer (default: `consumer-${task}`).
+May contain `${task}` as a placeholder for the task id.
+For example, `foo${task}` and task `123` => consumer `foo123`.
+<6> Destination topic (default: `${stream}`).
+May contain `${stream}` as a placeholder for the originating stream name.
+For example, `redis_${stream}` and stream `orders` => topic `redis_orders`.