Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(i18n): add desc for Datalayers #53

Merged
merged 2 commits into from
Aug 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/i18n/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# @emqx/shared-ui-i18n

## 0.0.22

### Patch Changes

- refactor(i18n): add desc for Datalayers

## 0.0.21

### Patch Changes
Expand Down
10 changes: 2 additions & 8 deletions packages/i18n/lib/enActionsLabel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ export const enActionsLabel: Record<string, Record<string, string>> = {
sync_query_timeout: 'Synchronous Query Timeout',
template: 'Message Template',
partitions_limit: 'Partitions Limit',
precision: 'Time Precision',
write_syntax: 'Write Syntax',
},
kafka_producer: {
timestamp: 'Message Timestamp',
Expand Down Expand Up @@ -91,10 +93,6 @@ export const enActionsLabel: Record<string, Record<string, string>> = {
data_type: 'Data Type',
value: 'Value',
},
influxdb: {
precision: 'Time Precision',
write_syntax: 'Write Syntax',
},
mqtt: {
topic: 'Topic',
qos: 'QoS',
Expand Down Expand Up @@ -167,10 +165,6 @@ export const enActionsLabel: Record<string, Record<string, string>> = {
stream_name: 'Amazon Kinesis Stream',
partition_key: 'Partition key',
},
greptimedb: {
write_syntax: 'Write Syntax',
precision: 'Time Precision',
},
tdengine: {
database: 'Database Name',
},
Expand Down
5 changes: 5 additions & 0 deletions packages/i18n/lib/enIntegrationDesc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,11 @@ export const enIntegrationDesc: Record<string, Record<string, string>> = {
"Conf of InfluxDB line protocol to write data points. It is a text-based format that provides the measurement, tag set, field set, and timestamp of a data point, and placeholder supported. See also [InfluxDB 2.3 Line Protocol](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/line-protocol/) and [InfluxDB 1.8 Line Protocol](https://docs.influxdata.com/influxdb/v1.8/write_protocols/line_protocol_tutorial/) <br/>TLDR:<br/>```<measurement>[,<tag_key>=<tag_value>[,<tag_key>=<tag_value>]] <field_key>=<field_value>[,<field_key>=<field_value>] [<timestamp>]```<br/>Please note that a placeholder for an integer value must be annotated with a suffix `i`. For example `${'{'}payload.int_value{'}'}i`.",
precision: 'InfluxDB time precision.',
},
datalayers: {
write_syntax:
'Datalayers adopts a line protocol fully compatible with InfluxDB v1, providing users with a familiar and efficient method for data ingestion. While compatible with InfluxDB v1 syntax, Datalayers has its unique characteristics in its underlying implementation to optimize performance and adapt to its specific storage structure. For more information, refer to [InfluxDB Line Protocol](https://docs.datalayers.cn/datalayers/latest/development-guide/writing-with-influxdb-line-protocol.html).',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Does this link have an English version? https://docs.datalayers.cn/datalayers/latest/development-guide/writing-with-influxdb-line-protocol.html I see it's redirecting to the CN site.

Copy link
Member

@ysfscream ysfscream Aug 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. In the last section of InfluxDB Line Protocol, I think it might confuse users into thinking it's the official InfluxDB documentation. Can we clarify this?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

e.g. Writing Data with InfluxDB Line Protocol in Datalayers.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Does this link have an English version? https://docs.datalayers.cn/datalayers/latest/development-guide/writing-with-influxdb-line-protocol.html I see it's redirecting to the CN site.

There's no English version here.

precision: 'Datalayers time precision.',
},
confluent_producer: {
connect_timeout:
'Maximum wait time for TCP connection establishment (including authentication time if enabled).',
Expand Down
10 changes: 2 additions & 8 deletions packages/i18n/lib/zhActionsLabel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ export const zhActionsLabel: Record<string, Record<string, string>> = {
sync_query_timeout: '同步查询超时时间',
template: '消息模板',
partitions_limit: '分区限制',
precision: '时间精度',
write_syntax: '写语句',
},
kafka_producer: {
timestamp: '消息的时间戳',
Expand Down Expand Up @@ -91,10 +93,6 @@ export const zhActionsLabel: Record<string, Record<string, string>> = {
data_type: '数据类型',
value: '值',
},
influxdb: {
precision: '时间精度',
write_syntax: '写语句',
},
mqtt: {
topic: '主题',
qos: 'QoS',
Expand Down Expand Up @@ -167,10 +165,6 @@ export const zhActionsLabel: Record<string, Record<string, string>> = {
stream_name: 'Amazon Kinesis 流',
partition_key: '分区键',
},
greptimedb: {
write_syntax: '写语法',
precision: '时间精度',
},
tdengine: {
database: '数据库名字',
},
Expand Down
5 changes: 5 additions & 0 deletions packages/i18n/lib/zhIntegrationDesc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,11 @@ export const zhIntegrationDesc: Record<string, Record<string, string>> = {
"使用 InfluxDB API Line Protocol 写入 InfluxDB 的数据,支持占位符,参考 [InfluxDB 2.3 Line Protocol](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/line-protocol/) 及 [InfluxDB 1.8 Line Protocol](https://docs.influxdata.com/influxdb/v1.8/write_protocols/line_protocol_tutorial/) <br/>TLDR: <br/>```<measurement>[,<tag_key>=<tag_value>[,<tag_key>=<tag_value>]] <field_key>=<field_value>[,<field_key>=<field_value>] [<timestamp>]```<br/>注意,整形数值占位符后需要添加一个字符 `i` 类型标识。例如 `${'{'}payload.int_value{'}'}i`",
precision: 'InfluxDB 时间精度。',
},
datalayers: {
write_syntax:
'Datalayers 采用与 InfluxDB v1 完全兼容的行协议,为用户提供了熟悉且高效的数据写入方式。虽然兼容InfluxDB v1 的语法,但 Datalayers 在底层实现上有其独特之处,以优化性能和适应其特定的存储结构。参考 [InfluxDB Line Protocol](https://docs.datalayers.cn/datalayers/latest/development-guide/writing-with-influxdb-line-protocol.html)',
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please check the desc

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

YES. same here.

precision: 'Datalayers 时间精度。',
},
confluent_producer: {
connect_timeout:
'建立 TCP 连接时的最大等待时长(若启用认证,这个等待时长也包含完成认证所需时间)。',
Expand Down
2 changes: 1 addition & 1 deletion packages/i18n/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@emqx/shared-ui-i18n",
"version": "0.0.21",
"version": "0.0.22",
"homepage": "https://emqx.io",
"license": "Apache-2.0",
"repository": {
Expand Down
Loading