docs: improve descriptions

Co-authored-by: Zaiming (Stone) Shi <zmstone@gmail.com>
This commit is contained in:
Thales Macedo Garitezi 2023-03-08 09:29:05 -03:00
parent 1b78f22d92
commit 9037314aea
1 changed files with 23 additions and 27 deletions

View File

@ -481,13 +481,13 @@ emqx_ee_bridge_kafka {
} }
label { label {
en: "Kafka Consumer" en: "Kafka Consumer"
zh: "Kafka Consumer" zh: "Kafka 消费者"
} }
} }
consumer_opts { consumer_opts {
desc { desc {
en: "Local MQTT data sink and Kafka bridge configs." en: "Local MQTT publish and Kafka consumer configs."
zh: "本地MQTT数据汇和Kafka桥配置。" zh: "本地 MQTT 转发 和 Kafka 消费者配置。"
} }
label { label {
en: "MQTT to Kafka" en: "MQTT to Kafka"
@ -501,23 +501,23 @@ emqx_ee_bridge_kafka {
} }
label { label {
en: "Kafka Consumer" en: "Kafka Consumer"
zh: "卡夫卡消费者" zh: "Kafka 消费者"
} }
} }
consumer_mqtt_opts { consumer_mqtt_opts {
desc { desc {
en: "MQTT data sink." en: "Local MQTT message publish."
zh: "MQTT数据汇。" zh: "本地 MQTT 消息转发。"
} }
label { label {
en: "MQTT data sink." en: "MQTT publish"
zh: "MQTT数据汇。" zh: "MQTT 转发"
} }
} }
consumer_mqtt_topic { consumer_mqtt_topic {
desc { desc {
en: "Local topic to which consumed Kafka messages should be published to." en: "Local topic to which consumed Kafka messages should be published to."
zh: "消耗的Kafka消息应该被发布到的本地主题。" zh: "设置 Kafka 消息向哪个本地 MQTT 主题转发消息。"
} }
label { label {
en: "MQTT Topic" en: "MQTT Topic"
@ -527,48 +527,44 @@ emqx_ee_bridge_kafka {
consumer_mqtt_qos { consumer_mqtt_qos {
desc { desc {
en: "MQTT QoS used to publish messages consumed from Kafka." en: "MQTT QoS used to publish messages consumed from Kafka."
zh: "MQTT QoS用于发布从Kafka消耗的消息。" zh: "转发 MQTT 消息时使用的 QoS。"
} }
label { label {
en: "MQTT Topic QoS" en: "QoS"
zh: "MQTT 主题服务质量" zh: "QoS"
} }
} }
consumer_mqtt_payload { consumer_mqtt_payload {
desc { desc {
en: "The payload of the MQTT message to be published.\n" en: "The payload of the MQTT message to be published.\n"
"<code>full_message</code> will encode all data available as a JSON object," "<code>full_message</code> will encode available Kafka message attributes as a JSON object, including Key, Value, Timestamp and Headers"
"<code>message_value</code> will directly use the Kafka message value as the " "<code>message_value</code> will directly use the Kafka message value as the "
"MQTT message payload." "MQTT message payload."
zh: "要发布的MQTT消息的有效载荷。" zh: "要发布的MQTT消息的有效载荷。"
"<code>full_message</code>将把所有可用数据编码为JSON对象" "<code>full_message</code>将把所有可用数据编码为JSON对象包括 KeyValueTimestamp 和 Headers。"
"<code>message_value</code>将直接使用Kafka消息值作为MQTT消息的有效载荷。" "<code>message_value</code>将直接使用 Kafka 消息值作为MQTT消息的 Payload。"
} }
label { label {
en: "MQTT Payload" en: "MQTT Payload"
zh: "MQTT有效载荷" zh: "MQTT Payload"
} }
} }
consumer_kafka_topic { consumer_kafka_topic {
desc { desc {
en: "Kafka topic to consume from." en: "Kafka topic to consume from."
zh: "从Kafka主题消费。" zh: "指定哪个 Kafka 主题消费消息。"
} }
label { label {
en: "Kafka topic" en: "Kafka topic"
zh: "卡夫卡主题 " zh: "Kafka 主题 "
} }
} }
consumer_max_batch_bytes { consumer_max_batch_bytes {
desc { desc {
en: "Maximum bytes to fetch in a batch of messages." en: "Maximum bytes to fetch in a batch of messages."
"NOTE: this value might be expanded to retry when " "Please note that if the configured value is smaller than the message size in Kafka, it may negatively impact the fetch performance."
"it is not enough to fetch even a single message, "
"then slowly shrink back to the given value."
zh: "在一批消息中要取的最大字节数。" zh: "在一批消息中要取的最大字节数。"
"注意:这个值可能会被扩大," "如果该配置小于 Kafka 中消息到大小,则可能会影响消费性能。"
"当它甚至不足以取到一条消息时,就会重试,"
"然后慢慢缩回到给定的值。"
} }
label { label {
en: "Max Bytes" en: "Max Bytes"
@ -594,13 +590,13 @@ emqx_ee_bridge_kafka {
} }
label { label {
en: "Offset Reset Policy" en: "Offset Reset Policy"
zh: "偏移重置策" zh: "偏移重置策"
} }
} }
consumer_offset_commit_interval_seconds { consumer_offset_commit_interval_seconds {
desc { desc {
en: "Defines the time interval between two <code>OffsetCommitRequest</code> messages." en: "Defines the time interval between two offset commit requests sent for each consumer group."
zh: "定义了两个<code>OffsetCommitRequest</code>消息之间的时间间隔。" zh: "指定 Kafka 消费组偏移量提交的时间间隔。"
} }
label { label {
en: "Offset Commit Interval" en: "Offset Commit Interval"