docs: separated key reader doc and fixed sync to sink

Author: Julien Ruaux

src/docs/asciidoc/_keyreader.adoc

@@ -0,0 +1,24 @@
+=== Key Reader
+In key reader mode, the source connector 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
+====
+The source connector supports the following data structures:
+
+* String: the Kafka record values will be strings
+* Hash: the Kafka record values will be maps (string key/value pairs)
+
+====
+
+[source,properties]
+----
+redis.keys.patterns=<glob> <1>
+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:*`)
+<2> Name of the destination topic.

src/docs/asciidoc/_sink.adoc

@@ -28,19 +28,19 @@ You can specify the number of tasks with the `tasks.max` configuration property.
 The {name} supports the following Redis data-structure types as targets:
 
 [[collection-key]]
-* Collections: <<sync-stream,stream>>, <<sync-list,list>>, <<sync-set,set>>, <<sync-zset,sorted set>>, <<sync-timeseries,time series>>
+* Collections: <<sink-stream,stream>>, <<sink-list,list>>, <<sink-set,set>>, <<sink-zset,sorted set>>, <<sink-timeseries,time series>>
 +
 Collection keys are generated using the `redis.key` configuration property which may contain `${topic}` (default) as a placeholder for the originating topic name.
 +
 For example with `redis.key = ${topic}` and topic `orders` the Redis key is `set:orders`.
 
-* <<sync-hash,Hash>>, <<sync-string,string>>, <<sync-json,JSON>>
+* <<sink-hash,Hash>>, <<sink-string,string>>, <<sink-json,JSON>>
 +
 For other data-structures the key is in the form `<keyspace>:<record_key>` where `keyspace` is generated using the `redis.key` configuration property like above and `record_key` is the sink record key.
 +
 For example with `redis.key = ${topic}`, topic `orders`, and sink record key `123` the Redis key is `orders:123`.
 
-[[sync-hash]]
+[[sink-hash]]
 ==== Hash
 Use the following properties to write Kafka records as Redis hashes:
 
@@ -55,7 +55,7 @@ value.converter=<Avro or JSON> <2>
 <2> <<avro,Avro>> or <<kafka-json,JSON>>.
 If value is null the key is deleted.
 
-[[sync-string]]
+[[sink-string]]
 ==== String
 Use the following properties to write Kafka records as Redis strings:
 
@@ -70,7 +70,7 @@ value.converter=<string or bytes> <2>
 <2> <<value-string,String>> or <<value-bytes,bytes>>.
 If value is null the key is deleted.
 
-[[sync-json]]
+[[sink-json]]
 ==== JSON
 Use the following properties to write Kafka records as RedisJSON documents:
 
@@ -85,7 +85,7 @@ value.converter=<string, bytes, or Avro> <2>
 <2> <<value-string,String>>, <<value-bytes,bytes>>, or <<avro,Avro>>.
 If value is null the key is deleted.
 
-[[sync-stream]]
+[[sink-stream]]
 ==== Stream
 Use the following properties to store Kafka records as Redis stream messages:
 
@@ -99,7 +99,7 @@ value.converter=<Avro or JSON> <2>
 <1> <<collection-key,Stream key>>
 <2> <<avro,Avro>> or <<kafka-json,JSON>>
 
-[[sync-list]]
+[[sink-list]]
 ==== List
 Use the following properties to add Kafka record keys to a Redis list:
 
@@ -118,7 +118,7 @@ redis.push.direction=<LEFT or RIGHT> <3>
 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).
 
-[[sync-set]]
+[[sink-set]]
 ==== Set
 Use the following properties to add Kafka record keys to a Redis set:
 
@@ -135,7 +135,7 @@ key.converter=<string or bytes> <2>
 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).
 
-[[sync-zset]]
+[[sink-zset]]
 ==== Sorted Set
 Use the following properties to add Kafka record keys to a Redis sorted set:
 
@@ -152,7 +152,7 @@ key.converter=<string or bytes> <2>
 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).
 
-[[sync-timeseries]]
+[[sink-timeseries]]
 ==== Time Series
 
 Use the following properties to write Kafka records as RedisTimeSeries samples:

src/docs/asciidoc/_source.adoc

@@ -42,32 +42,6 @@ Use configuration property `tasks.max` to have the change stream handled by mult
 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.
-//
-//[IMPORTANT]
-//.Supported Data Structures
-//====
-//The {name} supports the following data structures:
-//
-//* String: the Kafka record values will be strings
-//* Hash: the Kafka record values will be maps (string key/value pairs)
-//
-//====
-//
-//[source,properties]
-//----
-//redis.keys.patterns=<glob> <1>
-//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:*`)
-//<2> Name of the destination topic.
 
 [[stream-reader]]
 === Stream Reader
@@ -115,3 +89,6 @@ 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`.
+
+//[[key-reader]]
+//include::_keyreader.adoc[]