From 5bdc71af6fe34eb82a5c08a75f492da86cb125f5 Mon Sep 17 00:00:00 2001 From: Thales Macedo Garitezi Date: Fri, 24 Mar 2023 09:08:27 -0300 Subject: [PATCH 1/4] docs(kafka_consumer): make specific labels for key/value encoding modes https://emqx.atlassian.net/browse/EMQX-9312 --- .../i18n/emqx_ee_bridge_kafka.conf | 29 +++++++++++++++---- .../src/emqx_ee_bridge_kafka.erl | 4 +-- 2 files changed, 25 insertions(+), 8 deletions(-) diff --git a/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf b/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf index 00f1f1031..abf1c34b7 100644 --- a/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf +++ b/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf @@ -629,20 +629,37 @@ emqx_ee_bridge_kafka { zh: "主题映射关系" } } - consumer_encoding_mode { + consumer_key_encoding_mode { desc { - en: "Defines how the key or value from the Kafka message is" + en: "Defines how the key from the Kafka message is" " dealt with before being forwarded via MQTT.\n" - "none Uses the key or value from the Kafka message unchanged." - " Note: in this case, then the key or value must be a valid UTF-8 string.\n" - "base64 Uses base-64 encoding on the received key or value." + "none Uses the key from the Kafka message unchanged." + " Note: in this case, then the key must be a valid UTF-8 string.\n" + "base64 Uses base-64 encoding on the received key." zh: "定义了在通过MQTT转发之前如何处理Kafka消息的键或值。" "none 使用Kafka消息中的键或值，不改变。" " 注意：在这种情况下，那么键或值必须是一个有效的UTF-8字符串。\n" "base64 对收到的密钥或值使用base-64编码。" } label { - en: "Encoding Mode" + en: "Key Encoding Mode" + zh: "编码模式" + } + } + consumer_value_encoding_mode { + desc { + en: "Defines how the value from the Kafka message is" + " dealt with before being forwarded via MQTT.\n" + "none Uses the value from the Kafka message unchanged." + " Note: in this case, then the value must be a valid UTF-8 string.\n" + "base64 Uses base-64 encoding on the received value." + zh: "定义了在通过MQTT转发之前如何处理Kafka消息的键或值。" + "none 使用Kafka消息中的键或值，不改变。" + " 注意：在这种情况下，那么键或值必须是一个有效的UTF-8字符串。\n" + "base64 对收到的密钥或值使用base-64编码。" + } + label { + en: "Value Encoding Mode" zh: "编码模式" } } diff --git a/lib-ee/emqx_ee_bridge/src/emqx_ee_bridge_kafka.erl b/lib-ee/emqx_ee_bridge/src/emqx_ee_bridge_kafka.erl index 30a58e4e0..3db8dd5f1 100644 --- a/lib-ee/emqx_ee_bridge/src/emqx_ee_bridge_kafka.erl +++ b/lib-ee/emqx_ee_bridge/src/emqx_ee_bridge_kafka.erl @@ -338,11 +338,11 @@ fields(consumer_opts) -> )}, {key_encoding_mode, mk(enum([none, base64]), #{ - default => none, desc => ?DESC(consumer_encoding_mode) + default => none, desc => ?DESC(consumer_key_encoding_mode) })}, {value_encoding_mode, mk(enum([none, base64]), #{ - default => none, desc => ?DESC(consumer_encoding_mode) + default => none, desc => ?DESC(consumer_value_encoding_mode) })} ]; fields(consumer_topic_mapping) -> From ca820dfefc02ae0b47abb461f443525c3ad8331c Mon Sep 17 00:00:00 2001 From: Thales Macedo Garitezi Date: Fri, 24 Mar 2023 09:21:08 -0300 Subject: [PATCH 2/4] docs: improve descriptions Co-authored-by: Zaiming (Stone) Shi --- lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf b/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf index abf1c34b7..f93aef3c2 100644 --- a/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf +++ b/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf @@ -636,14 +636,14 @@ emqx_ee_bridge_kafka { "none Uses the key from the Kafka message unchanged." " Note: in this case, then the key must be a valid UTF-8 string.\n" "base64 Uses base-64 encoding on the received key." - zh: "定义了在通过MQTT转发之前如何处理Kafka消息的键或值。" - "none 使用Kafka消息中的键或值，不改变。" + zh: "定义了在通过MQTT转发之前如何处理Kafka消息的 Key。" + "none 使用Kafka消息中的 Key 原始值，不进行编码。” " 注意：在这种情况下，那么键或值必须是一个有效的UTF-8字符串。\n" "base64 对收到的密钥或值使用base-64编码。" } label { en: "Key Encoding Mode" - zh: "编码模式" + zh: "Key 编码模式" } } consumer_value_encoding_mode { @@ -653,8 +653,8 @@ emqx_ee_bridge_kafka { "none Uses the value from the Kafka message unchanged." " Note: in this case, then the value must be a valid UTF-8 string.\n" "base64 Uses base-64 encoding on the received value." - zh: "定义了在通过MQTT转发之前如何处理Kafka消息的键或值。" - "none 使用Kafka消息中的键或值，不改变。" + zh: "定义了在通过MQTT转发之前如何处理Kafka消息的 Value。" + "none 使用Kafka消息中的 Value 原始值，不进行编码。" " 注意：在这种情况下，那么键或值必须是一个有效的UTF-8字符串。\n" "base64 对收到的密钥或值使用base-64编码。" } From a239f0523aeab6456a3647e8c7e44698926663ae Mon Sep 17 00:00:00 2001 From: Thales Macedo Garitezi Date: Fri, 24 Mar 2023 09:23:06 -0300 Subject: [PATCH 3/4] docs: improve descriptions Co-authored-by: Zaiming (Stone) Shi --- lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf b/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf index f93aef3c2..28bfe7140 100644 --- a/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf +++ b/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf @@ -638,7 +638,7 @@ emqx_ee_bridge_kafka { "base64 Uses base-64 encoding on the received key." zh: "定义了在通过MQTT转发之前如何处理Kafka消息的 Key。" "none 使用Kafka消息中的 Key 原始值，不进行编码。” - " 注意：在这种情况下，那么键或值必须是一个有效的UTF-8字符串。\n" + " 注意：在这种情况下，Key 必须是一个有效的UTF-8字符串。\n" "base64 对收到的密钥或值使用base-64编码。" } label { @@ -655,12 +655,12 @@ emqx_ee_bridge_kafka { "base64 Uses base-64 encoding on the received value." zh: "定义了在通过MQTT转发之前如何处理Kafka消息的 Value。" "none 使用Kafka消息中的 Value 原始值，不进行编码。" - " 注意：在这种情况下，那么键或值必须是一个有效的UTF-8字符串。\n" - "base64 对收到的密钥或值使用base-64编码。" + " 注意：在这种情况下，Value 必须是一个有效的UTF-8字符串。\n" + "base64 对收到的 Value 使用base-64编码。" } label { en: "Value Encoding Mode" - zh: "编码模式" + zh: "Value 编码模式" } } } From c92af4f763d8686332e5ced2d1e63dc6bbaf1fb4 Mon Sep 17 00:00:00 2001 From: Thales Macedo Garitezi Date: Fri, 24 Mar 2023 09:48:35 -0300 Subject: [PATCH 4/4] docs: fix quote --- lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf b/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf index 28bfe7140..39b9d48f4 100644 --- a/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf +++ b/lib-ee/emqx_ee_bridge/i18n/emqx_ee_bridge_kafka.conf @@ -637,7 +637,7 @@ emqx_ee_bridge_kafka { " Note: in this case, then the key must be a valid UTF-8 string.\n" "base64 Uses base-64 encoding on the received key." zh: "定义了在通过MQTT转发之前如何处理Kafka消息的 Key。" - "none 使用Kafka消息中的 Key 原始值，不进行编码。” + "none 使用Kafka消息中的 Key 原始值，不进行编码。" " 注意：在这种情况下，Key 必须是一个有效的UTF-8字符串。\n" "base64 对收到的密钥或值使用base-64编码。" }