[GitHub] [flink-web] klion26 commented on a change in pull request #247: [FLINK-13683] Translate "Code Style - Component Guide" page into Chinese
klion26 commented on a change in pull request #247: URL: https://github.com/apache/flink-web/pull/247#discussion_r439216882 ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -48,96 +47,95 @@ How to name config keys: } ``` -* The resulting config keys should hence be: +* 因此生成的配置键应该： - **NOT** `"taskmanager.detailed.network.metrics"` + **不是** `"taskmanager.detailed.network.metrics"` - **But rather** `"taskmanager.network.detailed-metrics"` + **而是** `"taskmanager.network.detailed-metrics"` -### Connectors +### 连接器 -Connectors are historically hard to implement and need to deal with many aspects of threading, concurrency, and checkpointing. +连接器历来很难实现，需要处理多线程、并发和检查点等许多方面。 -As part of [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) we are working on making this much simpler for sources. New sources should not have to deal with any aspect of concurrency/threading and checkpointing any more. +作为 [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) 的一部分，我们正在努力实现数据源（source）。新的数据源应该不必处理并发/线程和检查点的任何方面。 Review comment: `作为 [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) 的一部分，我们正在努力实现数据源（source）` 这句话感觉不完整，正在实现数据源，然后就没了，和原文也有一点不太一样，原文是说使得 source 的实现更简单了 ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -9,24 +9,23 @@ title: "Apache Flink Code Style and Quality Guide — Components" -## Component Specific Guidelines +## 组件特定指南 -_Additional guidelines about changes in specific components._ +_关于特定组件更改的附加指南。_ -### Configuration Changes +### 配置更改 -Where should the config option go? +配置选项应该放在哪里？ -* ‘flink-conf.yaml’: All configuration that pertains to execution behavior that one may want to standardize across jobs. Think of it as parameters someone would set wearing an “ops” hat, or someone that provides a stream processing platform to other teams. +* ‘flink-conf.yaml’: 所有属于可能要跨作业标准化的执行行为配置。可以将其想像成 Ops 的工作人员，或为其他团队提供流处理平台的人。 Review comment: 我重新看了下。这里的意思是说 “flink-conf” 里面的参数是 ops 人员设置的吧，不是说这个是 ops 工作人员？ 这里是说 flink-conf 是 ops 工作人员或者提供平台的工作人员会统一设置的参数？ 可以想下如何描述会更好~ This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [flink-web] klion26 commented on a change in pull request #247: [FLINK-13683] Translate "Code Style - Component Guide" page into Chinese
klion26 commented on a change in pull request #247: URL: https://github.com/apache/flink-web/pull/247#discussion_r437135017 ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -48,96 +47,95 @@ How to name config keys: } ``` -* The resulting config keys should hence be: +* 因此生成的配置键应该： - **NOT** `"taskmanager.detailed.network.metrics"` + **不是** `"taskmanager.detailed.network.metrics"` - **But rather** `"taskmanager.network.detailed-metrics"` + **而是** `"taskmanager.network.detailed-metrics"` -### Connectors +### 连接器 -Connectors are historically hard to implement and need to deal with many aspects of threading, concurrency, and checkpointing. +连接器历来很难实现，需要处理多线程、并发和检查点等许多方面。 -As part of [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) we are working on making this much simpler for sources. New sources should not have to deal with any aspect of concurrency/threading and checkpointing any more. +作为 [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) 的一部分，我们正在努力让这些数据源（source）更加简单。新的数据源应该不必处理并发/线程和检查点的任何方面。 Review comment: `我们正在努力让这些数据源（source）更加简单` 这里改成 `实现数据源` 或者 `数据源实现` 等会更好一些吗？前面说 `连接器很难实现`，这里可以对应起来 ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -48,96 +47,95 @@ How to name config keys: } ``` -* The resulting config keys should hence be: +* 因此生成的配置键应该： - **NOT** `"taskmanager.detailed.network.metrics"` + **不是** `"taskmanager.detailed.network.metrics"` - **But rather** `"taskmanager.network.detailed-metrics"` + **而是** `"taskmanager.network.detailed-metrics"` -### Connectors +### 连接器 -Connectors are historically hard to implement and need to deal with many aspects of threading, concurrency, and checkpointing. +连接器历来很难实现，需要处理多线程、并发和检查点等许多方面。 -As part of [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) we are working on making this much simpler for sources. New sources should not have to deal with any aspect of concurrency/threading and checkpointing any more. +作为 [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) 的一部分，我们正在努力让这些数据源（source）更加简单。新的数据源应该不必处理并发/线程和检查点的任何方面。 -A similar FLIP can be expected for sinks in the near future. +预计在不久的将来，会有类似针对数据汇（sink）的 FLIP。 -### Examples +### 示例 -Examples should be self-contained and not require systems other than Flink to run. Except for examples that show how to use specific connectors, like the Kafka connector. Sources/sinks that are ok to use are `StreamExecutionEnvironment.socketTextStream`, which should not be used in production but is quite handy for exploring how things work, and file-based sources/sinks. (For streaming, there is the continuous file source) +示例应该是自包含的，不需要运行 Flink 以外的系统。除了显示如何使用具体的连接器的示例，比如 Kafka 连接器。数据源/数据汇可以使用 `StreamExecutionEnvironment.socketTextStream`，这个不应该在生产中使用，但对于研究示例如何运行是相当方便的，以及基于文件的数据源/数据源。（对于流，Flink 提供了连续的文件数据源读取数据） +示例也不应该是纯粹的玩具示例，而是在现实世界的代码和纯粹的抽象示例之间取得平衡。WordCount 示例到现在已经很久了，但它是一个很好的功能突出并可以做有用事情的简单代码示例。 -Examples should also not be pure toy-examples but strike a balance between real-world code and purely abstract examples. The WordCount example is quite long in the tooth by now but it’s a good showcase of simple code that highlights functionality and can do useful things. +示例中应该有不少的注释。他们可以在类级 Javadoc 中描述示例的总体思路，并且描述正在发生什么和整个代码里使用了什么功能。还应描述预期的输入数据和输出数据。 -Examples should also be heavy in comments. They should describe the general idea of the example in the class-level Javadoc and describe what is happening and what functionality is used throughout the code. The expected input data and output data should also be described. +示例应该包括参数解析，以便你可以运行一个示例（使用 `bin/flink run path/to/myExample.jar --param1 … --param2` 运行程序）。 -Examples should include parameter parsing, so that you can run an example (from the Jar that is created for each example using `bin/flink run path/to/myExample.jar --param1 … --param2`. +### 表和 SQL API -### Table & SQL API + 语义 - Semantics +**SQL 标准应该是事实的主要来源。** -**The SQL standard should be the main source of truth.** +* 语法、语义和功能应该和 SQL 保持一致！ +* 我们不需要重造轮子。大部分问题都已经在业界广泛讨论过并写在 SQL 标准中了。 +* 我们依靠最新的标准（在写这篇文档时使用 SQL:2016 or ISO/IEC 9075:2016 [[下载]](https://standards.iso.org/ittf/PubliclyAvailableStandards/c065143_ISO_IEC_TR_19075-5_2016.zip)）。并非每个部分都可在线获取，但快速网络搜索可能对此有所帮助。 Review comment: `但快速网络搜索可能对此有所帮助` 这个可以有一个更好的描述吗？现在这样读起来有一点突兀。 这里的意思应该上 标准可能在网上找不到（并不是所有的部分都能找到），但是首先应该通过网络查找确认？ ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -48,96 +47,95 @@ How to name config keys: } ``` -* The resulting config keys should hence be: +* 因此生成的配置键应该： - **NOT** `"taskmanager.detailed.network.metrics"` + **不是** `"taskmanager.detailed.network.metrics"` - **But rather**
[GitHub] [flink-web] klion26 commented on a change in pull request #247: [FLINK-13683] Translate "Code Style - Component Guide" page into Chinese
klion26 commented on a change in pull request #247: URL: https://github.com/apache/flink-web/pull/247#discussion_r432808804 ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -9,24 +9,24 @@ title: "Apache Flink Code Style and Quality Guide — Components" -## Component Specific Guidelines +## 组件特定指南 -_Additional guidelines about changes in specific components._ +_关于特定组件更改的附加指南。_ -### Configuration Changes +### 配置更改 -Where should the config option go? +配置选项应该放在哪里？ -* ‘flink-conf.yaml’: All configuration that pertains to execution behavior that one may want to standardize across jobs. Think of it as parameters someone would set wearing an “ops” hat, or someone that provides a stream processing platform to other teams. +* ‘flink-conf.yaml’: 所有属于可能要跨作业标准化的执行行为配置。可以将其想像成 Ops 的工作人员，或为其他团队提供流处理平台的设置参数。 Review comment: ```suggestion * ‘flink-conf.yaml’： 所有属于可能要跨作业标准化的执行行为配置。可以将其想像成 Ops 的工作人员，或为其他团队提供流处理平台的设置参数。 ``` 下面几句也同样修改掉吧 2 `可以将其想像成 Ops 的工作人员，或为其他团队提供流处理平台的设置参数` ，这句话读起来有点不太通顺的样子，前面的意思是想象成 `工作人员` 后面的意思读起来是 `设置参数`？ ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -48,96 +48,95 @@ How to name config keys: } ``` -* The resulting config keys should hence be: +* 因此生成的配置键应该： - **NOT** `"taskmanager.detailed.network.metrics"` + **不是** `"taskmanager.detailed.network.metrics"` - **But rather** `"taskmanager.network.detailed-metrics"` + **而是** `"taskmanager.network.detailed-metrics"` -### Connectors +### 连接器 -Connectors are historically hard to implement and need to deal with many aspects of threading, concurrency, and checkpointing. +连接器历来很难实现，需要处理多线程、并发和检查点的许多方面。 Review comment: `等许多方面`？ ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -48,96 +48,95 @@ How to name config keys: } ``` -* The resulting config keys should hence be: +* 因此生成的配置键应该： - **NOT** `"taskmanager.detailed.network.metrics"` + **不是** `"taskmanager.detailed.network.metrics"` - **But rather** `"taskmanager.network.detailed-metrics"` + **而是** `"taskmanager.network.detailed-metrics"` -### Connectors +### 连接器 -Connectors are historically hard to implement and need to deal with many aspects of threading, concurrency, and checkpointing. +连接器历来很难实现，需要处理多线程、并发和检查点的许多方面。 -As part of [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) we are working on making this much simpler for sources. New sources should not have to deal with any aspect of concurrency/threading and checkpointing any more. +作为 [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) 的一部分，我们正在努力让这些 source 更加简单。新的 source 应该不必处理并发/线程和检查点的任何方面。 -A similar FLIP can be expected for sinks in the near future. +预计在不久的将来，会有类似针对 sink 的 FLIP。 -### Examples +### 示例 -Examples should be self-contained and not require systems other than Flink to run. Except for examples that show how to use specific connectors, like the Kafka connector. Sources/sinks that are ok to use are `StreamExecutionEnvironment.socketTextStream`, which should not be used in production but is quite handy for exploring how things work, and file-based sources/sinks. (For streaming, there is the continuous file source) +示例应该是自包含的，不需要运行 Flink 以外的系统。除了显示如何使用具体的连接器的示例，比如 Kafka 连接器。source/sink 可以使用 `StreamExecutionEnvironment.socketTextStream`，这个不应该在生产中使用，但对于研究示例如何运行是相当方便的，以及基于文件的 source/sink。（对于流，有连续的文件 source） +示例也不应该是纯粹的玩具示例，而是在现实世界的代码和纯粹的抽象示例之间取得平衡。WordCount 示例到现在已经很久了，但它是一个很好的功能突出并可以做有用事情的简单代码示例。 -Examples should also not be pure toy-examples but strike a balance between real-world code and purely abstract examples. The WordCount example is quite long in the tooth by now but it’s a good showcase of simple code that highlights functionality and can do useful things. +示例中应该有不少的注释。他们可以在类级 Javadoc 中描述示例的总体思路，并且描述正在发生什么和整个代码里使用了什么功能。还应描述预期的输入数据和输出数据。 -Examples should also be heavy in comments. They should describe the general idea of the example in the class-level Javadoc and describe what is happening and what functionality is used throughout the code. The expected input data and output data should also be described. +示例应该包括参数解析，以便你可以运行一个示例（使用 `bin/flink run path/to/myExample.jar --param1 … --param2` 运行程序）。 -Examples should include parameter parsing, so that you can run an example (from the Jar that is created for each example using `bin/flink run path/to/myExample.jar --param1 … --param2`. +### 表和 SQL API -### Table & SQL API + 语义 - Semantics +**SQL 标准应该是事实的主要来源。** -**The SQL standard should be the main source of truth.** +* 语法、语义和功能应该和 SQL 保持一致！ +* 我们不需要重造轮子。大部分问题都已经在业界广泛讨论过并写在 SQL 标准中了。 +* 我们依靠最新的标准（在写这篇文档时使用 SQL:2016 or ISO/IEC 9075:2016 [[下载]](https://standards.iso.org/ittf/PubliclyAvailableStandards/c065143_ISO_IEC_TR_19075-5_2016.zip)）。并非每个部分都可在线获取，但快速网络搜索可能对此有所帮助。 -*
[GitHub] [flink-web] klion26 commented on a change in pull request #247: [FLINK-13683] Translate "Code Style - Component Guide" page into Chinese
klion26 commented on a change in pull request #247: URL: https://github.com/apache/flink-web/pull/247#discussion_r429771409 ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -48,96 +48,95 @@ How to name config keys: } ``` -* The resulting config keys should hence be: +* 因此生成的配置键应该： - **NOT** `"taskmanager.detailed.network.metrics"` + **不是** `"taskmanager.detailed.network.metrics"` - **But rather** `"taskmanager.network.detailed-metrics"` + **而是** `"taskmanager.network.detailed-metrics"` -### Connectors +### 连接器 -Connectors are historically hard to implement and need to deal with many aspects of threading, concurrency, and checkpointing. +连接器历来很难实现，需要处理多线程、并发和检查点的许多方面。 -As part of [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) we are working on making this much simpler for sources. New sources should not have to deal with any aspect of concurrency/threading and checkpointing any more. +作为 [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) 的一部分，我们正在努力让这些源（source）更加简单。新的源应该不必处理并发/线程和检查点的任何方面。 -A similar FLIP can be expected for sinks in the near future. +预计在不久的将来，会有类似针对 sink 的 FLIP。 -### Examples +### 示例 -Examples should be self-contained and not require systems other than Flink to run. Except for examples that show how to use specific connectors, like the Kafka connector. Sources/sinks that are ok to use are `StreamExecutionEnvironment.socketTextStream`, which should not be used in production but is quite handy for exploring how things work, and file-based sources/sinks. (For streaming, there is the continuous file source) +示例应该是自包含的，不需要运行 Flink 以外的系统。除了显示如何使用具体的连接器的示例，比如 Kafka 连接器。源/接收器可以使用 `StreamExecutionEnvironment.socketTextStream`，这个不应该在生产中使用，但对于研究示例如何运行是相当方便的，以及基于文件的源/接收器。（对于流，有连续的文件源） +示例也不应该是纯粹的玩具示例，而是在现实世界的代码和纯粹的抽象示例之间取得平衡。WordCount 示例到现在已经很久了，但它是一个很好的功能突出并可以做有用事情的简单代码示例。 -Examples should also not be pure toy-examples but strike a balance between real-world code and purely abstract examples. The WordCount example is quite long in the tooth by now but it’s a good showcase of simple code that highlights functionality and can do useful things. +示例中应该有不少的注释。他们可以在类级 Javadoc 中描述示例的总体思路，并且描述正在发生什么和整个代码里使用了什么功能。还应描述预期的输入数据和输出数据。 -Examples should also be heavy in comments. They should describe the general idea of the example in the class-level Javadoc and describe what is happening and what functionality is used throughout the code. The expected input data and output data should also be described. +示例应该包括参数解析，以便你可以运行一个示例（使用 `bin/flink run path/to/myExample.jar --param1 … --param2` 从为每个示例创建的 jar 运行程序）。 Review comment: "使用 `bin/flink run path/to/myExample.jar --param1 … --param2` 从为每个示例创建的 jar 运行程序" 这个地方是不是直接写成 "使用 `bin/flink run path/to/myExample.jar --param1 … --param2` 运行程序“ 就行？现在的翻译意思是可以的，读起来有一点点拗口，简化的目的是希望读起来更顺口（当然有其他的表达方式也是可以的） ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -48,96 +48,95 @@ How to name config keys: } ``` -* The resulting config keys should hence be: +* 因此生成的配置键应该： - **NOT** `"taskmanager.detailed.network.metrics"` + **不是** `"taskmanager.detailed.network.metrics"` - **But rather** `"taskmanager.network.detailed-metrics"` + **而是** `"taskmanager.network.detailed-metrics"` -### Connectors +### 连接器 -Connectors are historically hard to implement and need to deal with many aspects of threading, concurrency, and checkpointing. +连接器历来很难实现，需要处理多线程、并发和检查点的许多方面。 -As part of [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) we are working on making this much simpler for sources. New sources should not have to deal with any aspect of concurrency/threading and checkpointing any more. +作为 [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) 的一部分，我们正在努力让这些源（source）更加简单。新的源应该不必处理并发/线程和检查点的任何方面。 -A similar FLIP can be expected for sinks in the near future. +预计在不久的将来，会有类似针对 sink 的 FLIP。 -### Examples +### 示例 -Examples should be self-contained and not require systems other than Flink to run. Except for examples that show how to use specific connectors, like the Kafka connector. Sources/sinks that are ok to use are `StreamExecutionEnvironment.socketTextStream`, which should not be used in production but is quite handy for exploring how things work, and file-based sources/sinks. (For streaming, there is the continuous file source) +示例应该是自包含的，不需要运行 Flink 以外的系统。除了显示如何使用具体的连接器的示例，比如 Kafka 连接器。源/接收器可以使用 `StreamExecutionEnvironment.socketTextStream`，这个不应该在生产中使用，但对于研究示例如何运行是相当方便的，以及基于文件的源/接收器。（对于流，有连续的文件源） Review comment: 整个文档中的 "source" "sink" 这些次建议统一 1. “source” 在整个文档中进行统一，要么都不翻译，翻译的话都翻译成同样的词语 2. "source" 和 "sink" 是一对词，建议要么都翻译，要么都不翻译 上面 64 行的 sink 是没有翻译的，这里翻译成了接收器。 ## File path:
[GitHub] [flink-web] klion26 commented on a change in pull request #247: [FLINK-13683] Translate "Code Style - Component Guide" page into Chinese
klion26 commented on a change in pull request #247: URL: https://github.com/apache/flink-web/pull/247#discussion_r427758065 ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -48,96 +48,96 @@ How to name config keys: } ``` -* The resulting config keys should hence be: +* 因此生成的配置键应该是： - **NOT** `"taskmanager.detailed.network.metrics"` + **不是** `"taskmanager.detailed.network.metrics"` - **But rather** `"taskmanager.network.detailed-metrics"` + **而是** `"taskmanager.network.detailed-metrics"` -### Connectors +### 连接器 -Connectors are historically hard to implement and need to deal with many aspects of threading, concurrency, and checkpointing. +连接器历来很难实现，需要处理多线程、并发和检查点的许多方面。 -As part of [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) we are working on making this much simpler for sources. New sources should not have to deal with any aspect of concurrency/threading and checkpointing any more. +作为 [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) 的一部分，我们正在努力让这些源（source）更加简单。新的源应该不再处理并发/线程和检查点的任何方面。 -A similar FLIP can be expected for sinks in the near future. +预计在不久的将来，会有类似针对 sink 的 FLIP。 -### Examples +### 示例 -Examples should be self-contained and not require systems other than Flink to run. Except for examples that show how to use specific connectors, like the Kafka connector. Sources/sinks that are ok to use are `StreamExecutionEnvironment.socketTextStream`, which should not be used in production but is quite handy for exploring how things work, and file-based sources/sinks. (For streaming, there is the continuous file source) +示例应该是自包含的，不需要运行 Flink 以外的系统。除了显示如何使用具体的连接器的示例，比如 Kafka 连接器。源/接收器可以使用 `StreamExecutionEnvironment.socketTextStream`，这个不应该在生产中使用，但对于研究示例如何运行的是相当方便的，以及基于文件的源/接收器。（对于流，有连续的文件源） Review comment: ```suggestion 示例应该是自包含的，不需要运行 Flink 以外的系统。除了显示如何使用具体的连接器的示例，比如 Kafka 连接器。源/接收器可以使用 `StreamExecutionEnvironment.socketTextStream`，这个不应该在生产中使用，但对于研究示例如何运行是相当方便的，以及基于文件的源/接收器。（对于流，有连续的文件源） ``` ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -48,96 +48,96 @@ How to name config keys: } ``` -* The resulting config keys should hence be: +* 因此生成的配置键应该是： Review comment: 这句话连起来不太通顺，最简单的就是把 ”应该是“ 改成 ”应该”，另外可以想想是否有更好的翻译，不一定要一一对应，整个意思一样就行了。 ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -48,96 +48,96 @@ How to name config keys: } ``` -* The resulting config keys should hence be: +* 因此生成的配置键应该是： - **NOT** `"taskmanager.detailed.network.metrics"` + **不是** `"taskmanager.detailed.network.metrics"` - **But rather** `"taskmanager.network.detailed-metrics"` + **而是** `"taskmanager.network.detailed-metrics"` -### Connectors +### 连接器 -Connectors are historically hard to implement and need to deal with many aspects of threading, concurrency, and checkpointing. +连接器历来很难实现，需要处理多线程、并发和检查点的许多方面。 -As part of [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) we are working on making this much simpler for sources. New sources should not have to deal with any aspect of concurrency/threading and checkpointing any more. +作为 [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) 的一部分，我们正在努力让这些源（source）更加简单。新的源应该不再处理并发/线程和检查点的任何方面。 Review comment: "新的源应该不再处理并发/线程和检查点的任何方面。" 这一句中体现“not have to”是不是会更好一些 ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -48,96 +48,96 @@ How to name config keys: } ``` -* The resulting config keys should hence be: +* 因此生成的配置键应该是： - **NOT** `"taskmanager.detailed.network.metrics"` + **不是** `"taskmanager.detailed.network.metrics"` - **But rather** `"taskmanager.network.detailed-metrics"` + **而是** `"taskmanager.network.detailed-metrics"` -### Connectors +### 连接器 -Connectors are historically hard to implement and need to deal with many aspects of threading, concurrency, and checkpointing. +连接器历来很难实现，需要处理多线程、并发和检查点的许多方面。 -As part of [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) we are working on making this much simpler for sources. New sources should not have to deal with any aspect of concurrency/threading and checkpointing any more. +作为 [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) 的一部分，我们正在努力让这些源（source）更加简单。新的源应该不再处理并发/线程和检查点的任何方面。 -A similar FLIP can be expected for sinks in the near future. +预计在不久的将来，会有类似针对 sink 的 FLIP。 -### Examples +### 示例 -Examples should be self-contained and not require systems other than Flink to run. Except for examples that show how to use specific connectors, like the Kafka connector. Sources/sinks that are ok to use are `StreamExecutionEnvironment.socketTextStream`, which
[GitHub] [flink-web] klion26 commented on a change in pull request #247: [FLINK-13683] Translate "Code Style - Component Guide" page into Chinese
klion26 commented on a change in pull request #247: URL: https://github.com/apache/flink-web/pull/247#discussion_r425647065 ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -48,96 +48,96 @@ How to name config keys: } ``` -* The resulting config keys should hence be: +* 因此生成的配置键应该是： - **NOT** `"taskmanager.detailed.network.metrics"` + **不是** `"taskmanager.detailed.network.metrics"` - **But rather** `"taskmanager.network.detailed-metrics"` + **而是** `"taskmanager.network.detailed-metrics"` -### Connectors +### 连接器 -Connectors are historically hard to implement and need to deal with many aspects of threading, concurrency, and checkpointing. +连接器历来很难实现，需要处理线程、并发和检查点的许多方面。 Review comment: 这里的 "threading" 我理解翻译成 ”多线程“？现在的翻译”处理线程“感觉话没有说完一样 ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -48,96 +48,96 @@ How to name config keys: } ``` -* The resulting config keys should hence be: +* 因此生成的配置键应该是： - **NOT** `"taskmanager.detailed.network.metrics"` + **不是** `"taskmanager.detailed.network.metrics"` - **But rather** `"taskmanager.network.detailed-metrics"` + **而是** `"taskmanager.network.detailed-metrics"` -### Connectors +### 连接器 -Connectors are historically hard to implement and need to deal with many aspects of threading, concurrency, and checkpointing. +连接器历来很难实现，需要处理线程、并发和检查点的许多方面。 -As part of [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) we are working on making this much simpler for sources. New sources should not have to deal with any aspect of concurrency/threading and checkpointing any more. +作为 [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) 的一部分，我们正在努力让这些源（source）更加简单。新的源（source）应该不再处理并发/线程和检查点的任何方面。 Review comment: ”新的源（source）应该“ 可以直接写成 ”新的源“ 因为前面已经翻译过一次了。 ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -9,24 +9,24 @@ title: "Apache Flink Code Style and Quality Guide — Components" -## Component Specific Guidelines +## 组件特定指南 -_Additional guidelines about changes in specific components._ +_关于特定组件更改的附加指南。_ -### Configuration Changes +### 配置更改 -Where should the config option go? +配置选项应该放在哪里？ -* ‘flink-conf.yaml’: All configuration that pertains to execution behavior that one may want to standardize across jobs. Think of it as parameters someone would set wearing an “ops” hat, or someone that provides a stream processing platform to other teams. +* ‘flink-conf.yaml’: 文件中的内容是包括那些能够跨 job 共用的标准配置，因为配置在这个文件中的参数会被多个 job 共用。可以想像成 Ops 的工作人员，或者管理一个数据平台的工作人员那样，所以把通用的配置都放到 flink-conf.yaml 文件中。 Review comment: “可以想像成 Ops 的工作人员，或者管理一个数据平台的工作人员那样，所以把通用的配置都放到 flink-conf.yaml 文件中。” 这句话有点想口语，尤其是 ”工作人员那样“ 这里，咱们有更好的翻译吗？另外后面的 ”所以把XXX“ 这些感觉有点多余。 ## File path: contributing/code-style-and-quality-components.zh.md ## @@ -48,96 +48,96 @@ How to name config keys: } ``` -* The resulting config keys should hence be: +* 因此生成的配置键应该是： - **NOT** `"taskmanager.detailed.network.metrics"` + **不是** `"taskmanager.detailed.network.metrics"` - **But rather** `"taskmanager.network.detailed-metrics"` + **而是** `"taskmanager.network.detailed-metrics"` -### Connectors +### 连接器 -Connectors are historically hard to implement and need to deal with many aspects of threading, concurrency, and checkpointing. +连接器历来很难实现，需要处理线程、并发和检查点的许多方面。 -As part of [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) we are working on making this much simpler for sources. New sources should not have to deal with any aspect of concurrency/threading and checkpointing any more. +作为 [FLIP-27](https://cwiki.apache.org/confluence/display/FLINK/FLIP-27%3A+Refactor+Source+Interface) 的一部分，我们正在努力让这些源（source）更加简单。新的源（source）应该不再处理并发/线程和检查点的任何方面。 -A similar FLIP can be expected for sinks in the near future. +预计在不久的将来，类似的 FLIP 可以用于接收器。 -### Examples +### 示例 -Examples should be self-contained and not require systems other than Flink to run. Except for examples that show how to use specific connectors, like the Kafka connector. Sources/sinks that are ok to use are `StreamExecutionEnvironment.socketTextStream`, which should not be used in production but is quite handy for exploring how things work, and file-based sources/sinks. (For streaming, there is the continuous file source) +示例应该是自包含的，不需要运行 Flink 以外的系统。除了显示如何使用具体的连接器的示例，比如 Kafka 连接器。源/接收器可以使用 `StreamExecutionEnvironment.socketTextStream` ，这个不应该在生产中使用，但对于研究示例如何运行的是相当方便的，以及基于文件的源/接收器。（对于流，有连续的文件源） -Examples should also not be pure toy-examples but strike a balance between real-world code and purely abstract examples. The WordCount example is quite long in the tooth by now but it’s a good showcase of simple code that highlights functionality and can do useful things.
