Explorar el Código

docs: fix typos (#1839)

* docs: fix typos

Signed-off-by: xjasonlyu <xjasonlyu@gmail.com>

* docs(concepts): leave spaces outside of braces

Signed-off-by: xjasonlyu <xjasonlyu@gmail.com>

* docs: fix misc linguistic issues

Signed-off-by: xjasonlyu <xjasonlyu@gmail.com>

---------

Signed-off-by: xjasonlyu <xjasonlyu@gmail.com>
Jason Lyu hace 1 año
padre
commit
15d2c7f0dc

+ 1 - 1
docs/en_US/CONTRIBUTING.md

@@ -239,7 +239,7 @@ Closes: #123, #245, #992
 
 #### Revert
 
-If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
 
 #### Type
 

+ 1 - 1
docs/en_US/example/data_merge/merge_single_stream.md

@@ -40,7 +40,7 @@ Combine data from the same group of sensors (temperature and humidity) for subse
 ```json
 {
   "temperature": 27.23,
-   "humidity": 79.66,
+  "humidity": 79.66,
   "ts": 1681786070368
 }
 ```

+ 10 - 10
docs/zh_CN/CONTRIBUTING.md

@@ -4,8 +4,8 @@
 
 ## 发现 bug ?
 
-- **通过在 GitHub 的[问题](https://github.com/lf-edge/ekuiper/issues)下搜索,确保该错误尚未被报告**。
-- 如果你找不到解决该问题的公开问题,[开一个新问题](https://github.com/lf-edge/ekuiper/issues/new)。请确保**标题和清晰的描述**,尽可能多的相关信息,以及**代码样本**或**可执行的测试案例**,以明确问题。
+- **通过在 GitHub 的 [Issues](https://github.com/lf-edge/ekuiper/issues)下搜索,确保该错误尚未被报告**。
+- 如果你找不到解决该问题的公开问题,[开一个新的 Issue](https://github.com/lf-edge/ekuiper/issues/new)。请确保**标题和清晰的描述**,尽可能多的相关信息,以及**代码样本**或**可执行的测试案例**,以明确问题。
 
 ## 代码和文档贡献
 
@@ -165,9 +165,9 @@ eKuiper 项目利用 Github actions 来运行单元测试和 FVT(功能验证
 
 所有贡献给eKuiper的代码都将在Apache License V2下授权。你需要确保你添加的每个新文件都有正确的许可证头。
 
-### Signoff
+### Sign-off
 
-Signoff 是为了证明提交的来源。它是提交给这个项目的必要条件。如果你设置了
+Sign-off 是为了证明提交的来源。它是提交给这个项目的必要条件。如果你设置了
 你的`user.name`和`user.email`的 git 配置,你可以用`git commit -s`自动签署你的提交。每次提交都必须签名。
 
 ### 同步
@@ -220,20 +220,20 @@ git rebase -i upstream/master
 例子1:
 
 ```
-feat: 添加编译文件
+feat: add Fuji release compose files
 ```
 
 ```
-fix(script): 纠正运行脚本以使用正确的端口
+fix(script): correct run script to use the right ports
 
-以前的设备服务使用了错误的端口号。这个提交修正了端口号,使用最新的端口号。
+Previously device services used wrong port numbers. This commit fixes the port numbers to use the latest port numbers.
 
-关闭。#123, #245, #992
+Closes: #123, #245, #992
 ```
 
 #### Revert
 
-如果该提交是为了恢复之前的提交,它应该以 `revert: `开头,然后是被恢复的提交的标题。在正文中,应该说:"这是对提交 hash 的恢复",其中的 hash 是被恢复的提交的 SHA 值。
+如果该提交是为了恢复之前的提交,它应该以 `revert:` 开头,然后是被恢复的提交的标题。在正文中,应该说:`This reverts commit <hash>.`,其中的 hash 是被恢复的提交的 SHA 值。
 
 #### 类型
 
@@ -271,7 +271,7 @@ fix(script): 纠正运行脚本以使用正确的端口
 
 页脚应该包含任何关于**突破性变化的信息,同时也是引用此提交**关闭的 GitHub 问题的地方。
 
-**Breaking Changes** 应该以 "BREAKING CHANGE: "开头,并加上一个空格或两个换行。提交信息的其余部分就用于此了。
+**Breaking Changes** 应该以 `BREAKING CHANGE:` 开头,并加上一个空格或两个换行。提交信息的其余部分就用于此了。
 
 ## 社区推广
 

+ 1 - 1
docs/zh_CN/api/cli/plugins.md

@@ -25,7 +25,7 @@ create plugin $plugin_type $plugin_name $plugin_json | create plugin $plugin_typ
 
 该命令创建一个名为 `random` 的源插件。
 
-- 在文件中指定插件定义。 如果插件很复杂,或者插件已经以规范有序的格式写在文本文件中,则只需通过 `-f` 选项指定插件定义即可。
+- 在文件中指定插件定义。如果插件很复杂,或者插件已经以规范有序的格式写在文本文件中,则只需通过 `-f` 选项指定插件定义即可。
 
 示例:
 

+ 1 - 1
docs/zh_CN/concepts/ekuiper.md

@@ -19,7 +19,7 @@ eKuiper 采用 Go 语言编写,其架构如下图所示:
 
 ## 计算组件
 
-在 eKuiper ,计算工作以规则的形式呈现。规则以流的数据源为输入,通过 SQL 定义计算逻辑,将结果输出到动作/sink 中。
+在 eKuiper ,计算工作以规则的形式呈现。规则以流的数据源为输入,通过 SQL 定义计算逻辑,将结果输出到动作/sink 中。
 
 规则定义提交后,它将持续运行。它将不断从源获取数据,根据 SQL 逻辑进行计算,并根据结果触发行动。
 

La diferencia del archivo ha sido suprimido porque es demasiado grande
+ 1 - 1
docs/zh_CN/concepts/sources/overview.md


+ 1 - 1
docs/zh_CN/edgex/edgex_meta.md

@@ -87,7 +87,7 @@ SELECT temperature,humidity, meta(id) AS eid,meta(origin) AS eo, meta(temperatur
 
 ## 总结
 
-Kuper 的 `meta` 函数可以用于访问元数据,以下列出了所有在 EdgeX 的 `Event` 和 `Reading` 中支持的 key,
+eKuiper 的 `meta` 函数可以用于访问元数据,以下列出了所有在 EdgeX 的 `Event` 和 `Reading` 中支持的 key,
 
 - Event: id, deviceName, profileName, sourceName, origin, tags, correlationid
 - Reading: id, deviceName, profileName, origin, valueType

+ 1 - 1
docs/zh_CN/example/data_merge/merge_single_stream.md

@@ -40,7 +40,7 @@
 ```json
 {
   "temperature": 27.23,
-   "humidity": 79.66,
+  "humidity": 79.66,
   "ts": 1681786070368
 }
 ```