RocMarshal commented on code in PR #19403: URL: https://github.com/apache/flink/pull/19403#discussion_r846785106
########## docs/content.zh/docs/dev/configuration/overview.md: ########## @@ -36,39 +36,44 @@ specific language governing permissions and limitations under the License. --> +<a name="project-configuration"></a> Review Comment: ```suggestion <a name="project-configuration"></a> ``` ########## docs/content.zh/docs/dev/configuration/overview.md: ########## @@ -36,39 +36,44 @@ specific language governing permissions and limitations under the License. --> +<a name="project-configuration"></a> # 项目配置 -本节将向您展示如何通过流行的构建工具 ([Maven]({{< ref "docs/dev/configuration/maven" >}})、[Gradle]({{< ref "docs/dev/configuration/gradle" >}})) 配置您的项目,必要的依赖项(比如[连接器和格式]({{< ref "docs/dev/configuration/connector" >}})),以及覆盖一些[高级]({{< ref "docs/dev/configuration/advanced" >}})配置主题。 +本节将向你展示如何通过流行的构建工具 ([Maven]({{< ref "docs/dev/configuration/maven" >}})、[Gradle]({{< ref "docs/dev/configuration/gradle" >}})) 配置你的项目,必要的依赖项(比如[连接器和格式]({{< ref "docs/dev/configuration/connector" >}})),以及覆盖一些[高级]({{< ref "docs/dev/configuration/advanced" >}})配置主题。 每个 Flink 应用程序都依赖于一组 Flink 库。应用程序至少依赖于 Flink API,此外还依赖于某些连接器库(比如 Kafka、Cassandra),以及用户开发的自定义的数据处理逻辑所需要的第三方依赖项。 +<a name="getting-started"></a> ## 开始 要开始使用 Flink 应用程序,请使用以下命令、脚本和模板来创建 Flink 项目。 {{< tabs "creating project" >}} {{< tab "Maven" >}} -您可以使用如下的 Maven 命令或快速启动脚本,基于[原型](https://maven.apache.org/guides/introduction/introduction-to-archetypes.html)创建一个项目。 +你可以使用如下的 Maven 命令或快速启动脚本,基于[原型](https://maven.apache.org/guides/introduction/introduction-to-archetypes.html)创建一个项目。 +<a name="maven-command"></a> Review Comment: ```suggestion <a name="maven-command"></a> ``` ########## docs/content.zh/docs/dev/configuration/overview.md: ########## @@ -166,21 +184,23 @@ bash -c "$(curl https://flink.apache.org/q/gradle-quickstart.sh)" -- {{< version {{< /tab >}} {{< /tabs >}} +<a name="which-dependencies-do-you-need"></a> ## 需要哪些依赖项? -要开始一个 Flink 作业,您通常需要如下依赖项: +要开始一个 Flink 作业,你通常需要如下依赖项: -* Flink API, 用来开发您的作业 -* [连接器和格式]({{< ref "docs/dev/configuration/connector" >}}), 以将您的作业与外部系统集成 -* [测试实用程序]({{< ref "docs/dev/configuration/testing" >}}), 以测试您的作业 +* Flink API, 用来开发你的作业 +* [连接器和格式]({{< ref "docs/dev/configuration/connector" >}}), 以将你的作业与外部系统集成 +* [测试实用程序]({{< ref "docs/dev/configuration/testing" >}}), 以测试你的作业 Review Comment: ```suggestion * [测试实用程序]({{< ref "docs/dev/configuration/testing" >}}),以测试你的作业 ``` ########## docs/content.zh/docs/dev/configuration/overview.md: ########## @@ -166,21 +184,23 @@ bash -c "$(curl https://flink.apache.org/q/gradle-quickstart.sh)" -- {{< version {{< /tab >}} {{< /tabs >}} +<a name="which-dependencies-do-you-need"></a> ## 需要哪些依赖项? -要开始一个 Flink 作业,您通常需要如下依赖项: +要开始一个 Flink 作业,你通常需要如下依赖项: -* Flink API, 用来开发您的作业 -* [连接器和格式]({{< ref "docs/dev/configuration/connector" >}}), 以将您的作业与外部系统集成 -* [测试实用程序]({{< ref "docs/dev/configuration/testing" >}}), 以测试您的作业 +* Flink API, 用来开发你的作业 +* [连接器和格式]({{< ref "docs/dev/configuration/connector" >}}), 以将你的作业与外部系统集成 Review Comment: ```suggestion * [连接器和格式]({{< ref "docs/dev/configuration/connector" >}}),以将你的作业与外部系统集成 ``` ########## docs/content.zh/docs/dev/configuration/overview.md: ########## @@ -36,39 +36,44 @@ specific language governing permissions and limitations under the License. --> +<a name="project-configuration"></a> # 项目配置 -本节将向您展示如何通过流行的构建工具 ([Maven]({{< ref "docs/dev/configuration/maven" >}})、[Gradle]({{< ref "docs/dev/configuration/gradle" >}})) 配置您的项目,必要的依赖项(比如[连接器和格式]({{< ref "docs/dev/configuration/connector" >}})),以及覆盖一些[高级]({{< ref "docs/dev/configuration/advanced" >}})配置主题。 +本节将向你展示如何通过流行的构建工具 ([Maven]({{< ref "docs/dev/configuration/maven" >}})、[Gradle]({{< ref "docs/dev/configuration/gradle" >}})) 配置你的项目,必要的依赖项(比如[连接器和格式]({{< ref "docs/dev/configuration/connector" >}})),以及覆盖一些[高级]({{< ref "docs/dev/configuration/advanced" >}})配置主题。 每个 Flink 应用程序都依赖于一组 Flink 库。应用程序至少依赖于 Flink API,此外还依赖于某些连接器库(比如 Kafka、Cassandra),以及用户开发的自定义的数据处理逻辑所需要的第三方依赖项。 +<a name="getting-started"></a> ## 开始 要开始使用 Flink 应用程序,请使用以下命令、脚本和模板来创建 Flink 项目。 {{< tabs "creating project" >}} {{< tab "Maven" >}} -您可以使用如下的 Maven 命令或快速启动脚本,基于[原型](https://maven.apache.org/guides/introduction/introduction-to-archetypes.html)创建一个项目。 +你可以使用如下的 Maven 命令或快速启动脚本,基于[原型](https://maven.apache.org/guides/introduction/introduction-to-archetypes.html)创建一个项目。 +<a name="maven-command"></a> ### Maven 命令 ```bash $ mvn archetype:generate \ -DarchetypeGroupId=org.apache.flink \ -DarchetypeArtifactId=flink-quickstart-java \ -DarchetypeVersion={{< version >}} ``` -这允许您命名新建的项目,而且会交互式地询问 groupId、artifactId、package 的名字。 +这允许你命名新建的项目,而且会交互式地询问 groupId、artifactId、package 的名字。 +<a name="quickstart-script"></a> Review Comment: ```suggestion <a name="quickstart-script"></a> ``` ########## docs/content.zh/docs/dev/configuration/overview.md: ########## @@ -166,21 +184,23 @@ bash -c "$(curl https://flink.apache.org/q/gradle-quickstart.sh)" -- {{< version {{< /tab >}} {{< /tabs >}} +<a name="which-dependencies-do-you-need"></a> ## 需要哪些依赖项? -要开始一个 Flink 作业,您通常需要如下依赖项: +要开始一个 Flink 作业,你通常需要如下依赖项: -* Flink API, 用来开发您的作业 -* [连接器和格式]({{< ref "docs/dev/configuration/connector" >}}), 以将您的作业与外部系统集成 -* [测试实用程序]({{< ref "docs/dev/configuration/testing" >}}), 以测试您的作业 +* Flink API, 用来开发你的作业 Review Comment: ```suggestion * Flink API,用来开发你的作业 ``` ########## docs/content.zh/docs/dev/configuration/overview.md: ########## @@ -189,18 +209,20 @@ Flink提供了两大 API:[Datastream API]({{< ref "docs/dev/datastream/overvie | [Table API + DataStream]({{< ref "docs/dev/table/data_stream_api" >}}) | `flink-table-api-java-bridge` | | [Table API + DataStream Scala 版]({{< ref "docs/dev/table/data_stream_api" >}}) | `flink-table-api-scala-bridge{{< scala_version >}}` | -您只需将它们包含在您的构建工具脚本/描述符中,就可以开发您的作业了! +你只需将它们包含在你的构建工具脚本/描述符中,就可以开发你的作业了! +<a name="running-and-packaging"></a> Review Comment: ```suggestion <a name="running-and-packaging"></a> ``` ########## docs/content.zh/docs/dev/configuration/overview.md: ########## @@ -36,39 +36,44 @@ specific language governing permissions and limitations under the License. --> +<a name="project-configuration"></a> # 项目配置 -本节将向您展示如何通过流行的构建工具 ([Maven]({{< ref "docs/dev/configuration/maven" >}})、[Gradle]({{< ref "docs/dev/configuration/gradle" >}})) 配置您的项目,必要的依赖项(比如[连接器和格式]({{< ref "docs/dev/configuration/connector" >}})),以及覆盖一些[高级]({{< ref "docs/dev/configuration/advanced" >}})配置主题。 +本节将向你展示如何通过流行的构建工具 ([Maven]({{< ref "docs/dev/configuration/maven" >}})、[Gradle]({{< ref "docs/dev/configuration/gradle" >}})) 配置你的项目,必要的依赖项(比如[连接器和格式]({{< ref "docs/dev/configuration/connector" >}})),以及覆盖一些[高级]({{< ref "docs/dev/configuration/advanced" >}})配置主题。 每个 Flink 应用程序都依赖于一组 Flink 库。应用程序至少依赖于 Flink API,此外还依赖于某些连接器库(比如 Kafka、Cassandra),以及用户开发的自定义的数据处理逻辑所需要的第三方依赖项。 +<a name="getting-started"></a> Review Comment: ```suggestion <a name="getting-started"></a> ``` ########## docs/content.zh/docs/dev/configuration/overview.md: ########## @@ -166,21 +184,23 @@ bash -c "$(curl https://flink.apache.org/q/gradle-quickstart.sh)" -- {{< version {{< /tab >}} {{< /tabs >}} +<a name="which-dependencies-do-you-need"></a> ## 需要哪些依赖项? -要开始一个 Flink 作业,您通常需要如下依赖项: +要开始一个 Flink 作业,你通常需要如下依赖项: -* Flink API, 用来开发您的作业 -* [连接器和格式]({{< ref "docs/dev/configuration/connector" >}}), 以将您的作业与外部系统集成 -* [测试实用程序]({{< ref "docs/dev/configuration/testing" >}}), 以测试您的作业 +* Flink API, 用来开发你的作业 +* [连接器和格式]({{< ref "docs/dev/configuration/connector" >}}), 以将你的作业与外部系统集成 +* [测试实用程序]({{< ref "docs/dev/configuration/testing" >}}), 以测试你的作业 -除此之外,若要开发自定义功能,您还要添加必要的第三方依赖项。 +除此之外,若要开发自定义功能,你还要添加必要的第三方依赖项。 +<a name="flink-apis"></a> Review Comment: ```suggestion <a name="flink-apis"></a> ``` ########## docs/content.zh/docs/dev/configuration/overview.md: ########## @@ -36,39 +36,44 @@ specific language governing permissions and limitations under the License. --> +<a name="project-configuration"></a> # 项目配置 -本节将向您展示如何通过流行的构建工具 ([Maven]({{< ref "docs/dev/configuration/maven" >}})、[Gradle]({{< ref "docs/dev/configuration/gradle" >}})) 配置您的项目,必要的依赖项(比如[连接器和格式]({{< ref "docs/dev/configuration/connector" >}})),以及覆盖一些[高级]({{< ref "docs/dev/configuration/advanced" >}})配置主题。 +本节将向你展示如何通过流行的构建工具 ([Maven]({{< ref "docs/dev/configuration/maven" >}})、[Gradle]({{< ref "docs/dev/configuration/gradle" >}})) 配置你的项目,必要的依赖项(比如[连接器和格式]({{< ref "docs/dev/configuration/connector" >}})),以及覆盖一些[高级]({{< ref "docs/dev/configuration/advanced" >}})配置主题。 每个 Flink 应用程序都依赖于一组 Flink 库。应用程序至少依赖于 Flink API,此外还依赖于某些连接器库(比如 Kafka、Cassandra),以及用户开发的自定义的数据处理逻辑所需要的第三方依赖项。 +<a name="getting-started"></a> ## 开始 要开始使用 Flink 应用程序,请使用以下命令、脚本和模板来创建 Flink 项目。 {{< tabs "creating project" >}} {{< tab "Maven" >}} -您可以使用如下的 Maven 命令或快速启动脚本,基于[原型](https://maven.apache.org/guides/introduction/introduction-to-archetypes.html)创建一个项目。 +你可以使用如下的 Maven 命令或快速启动脚本,基于[原型](https://maven.apache.org/guides/introduction/introduction-to-archetypes.html)创建一个项目。 +<a name="maven-command"></a> ### Maven 命令 ```bash $ mvn archetype:generate \ -DarchetypeGroupId=org.apache.flink \ -DarchetypeArtifactId=flink-quickstart-java \ -DarchetypeVersion={{< version >}} ``` -这允许您命名新建的项目,而且会交互式地询问 groupId、artifactId、package 的名字。 +这允许你命名新建的项目,而且会交互式地询问 groupId、artifactId、package 的名字。 +<a name="quickstart-script"></a> ### 快速启动脚本 ```bash $ curl https://flink.apache.org/q/quickstart.sh | bash -s {{< version >}} ``` {{< /tab >}} {{< tab "Gradle" >}} -您可以使用如下的 Gradle 构建脚本或快速启动脚本创建一个项目。 +你可以创建一个空项目,你需要在其中手动创建 `src/main/java` 和 `src/main/resources` 目录并开始在其中编写一些类,使用如下 Gradle 构建脚本或下面提供的快速启动脚本以获得功能齐全的启动项目。 +<a name="gradle-build-script"></a> Review Comment: ```suggestion <a name="gradle-build-script"></a> ``` ########## docs/content.zh/docs/dev/configuration/overview.md: ########## @@ -158,6 +175,7 @@ shadowJar { rootProject.name = 'quickstart' ``` +<a name="quickstart-script"></a> Review Comment: ```suggestion <a name="quickstart-script"></a> ``` ########## docs/content.zh/docs/dev/configuration/overview.md: ########## @@ -189,18 +209,20 @@ Flink提供了两大 API:[Datastream API]({{< ref "docs/dev/datastream/overvie | [Table API + DataStream]({{< ref "docs/dev/table/data_stream_api" >}}) | `flink-table-api-java-bridge` | | [Table API + DataStream Scala 版]({{< ref "docs/dev/table/data_stream_api" >}}) | `flink-table-api-scala-bridge{{< scala_version >}}` | -您只需将它们包含在您的构建工具脚本/描述符中,就可以开发您的作业了! +你只需将它们包含在你的构建工具脚本/描述符中,就可以开发你的作业了! +<a name="running-and-packaging"></a> ## 运行和打包 -如果您想通过简单地执行主类来运行你的作业,您需要 classpath 里有 `flink-runtime`。对于 Table API 程序,您还需要 `flink-table-runtime` 和 `flink-table-planner-loader`。 +如果你想通过简单地执行主类来运行你的作业,你需要 classpath 里有 `flink-runtime`。对于 Table API 程序,你还需要 `flink-table-runtime` 和 `flink-table-planner-loader`。 -根据经验,我们**建议**将应用程序代码及其所有必需的依赖项打包进一个 fat/uber JAR 中。这包括打包您作业用到的连接器、格式和第三方依赖项。此规则**不适用于** Java API、DataStream Scala API 以及前面提到的运行时模块,它们已经由 Flink 本身提供,**不应**包含在作业的 uber JAR 中。您可以把该作业 JAR 提交到已经运行的 Flink 集群,也可以轻松将其添加到 Flink 应用程序容器镜像中,而无需修改发行版。 +根据经验,我们**建议**将应用程序代码及其所有必需的依赖项打包进一个 fat/uber JAR 中。这包括打包你作业用到的连接器、格式和第三方依赖项。此规则**不适用于** Java API、DataStream Scala API 以及前面提到的运行时模块,它们已经由 Flink 本身提供,**不应**包含在作业的 uber JAR 中。你可以把该作业 JAR 提交到已经运行的 Flink 集群,也可以轻松将其添加到 Flink 应用程序容器镜像中,而无需修改发行版。 +<a name="whats-next"></a> ## 下一步是什么? -* 要开发您的作业,请查阅 [DataStream API]({{< ref "docs/dev/datastream/overview" >}}) 和 [Table API & SQL]({{< ref "docs/dev/table/overview" >}}); -* 关于如何使用特定的构建工具打包您的作业的更多细节,请查阅如下指南: +* 要开发你的作业,请查阅 [DataStream API]({{< ref "docs/dev/datastream/overview" >}}) 和 [Table API & SQL]({{< ref "docs/dev/table/overview" >}}); Review Comment: ```suggestion * 要开发你的作业,请查阅 [DataStream API]({{< ref "docs/dev/datastream/overview" >}}) 和 [Table API & SQL]({{< ref "docs/dev/table/overview" >}}); ``` ########## docs/content.zh/docs/dev/configuration/overview.md: ########## @@ -189,18 +209,20 @@ Flink提供了两大 API:[Datastream API]({{< ref "docs/dev/datastream/overvie | [Table API + DataStream]({{< ref "docs/dev/table/data_stream_api" >}}) | `flink-table-api-java-bridge` | | [Table API + DataStream Scala 版]({{< ref "docs/dev/table/data_stream_api" >}}) | `flink-table-api-scala-bridge{{< scala_version >}}` | -您只需将它们包含在您的构建工具脚本/描述符中,就可以开发您的作业了! +你只需将它们包含在你的构建工具脚本/描述符中,就可以开发你的作业了! +<a name="running-and-packaging"></a> ## 运行和打包 -如果您想通过简单地执行主类来运行你的作业,您需要 classpath 里有 `flink-runtime`。对于 Table API 程序,您还需要 `flink-table-runtime` 和 `flink-table-planner-loader`。 +如果你想通过简单地执行主类来运行你的作业,你需要 classpath 里有 `flink-runtime`。对于 Table API 程序,你还需要 `flink-table-runtime` 和 `flink-table-planner-loader`。 -根据经验,我们**建议**将应用程序代码及其所有必需的依赖项打包进一个 fat/uber JAR 中。这包括打包您作业用到的连接器、格式和第三方依赖项。此规则**不适用于** Java API、DataStream Scala API 以及前面提到的运行时模块,它们已经由 Flink 本身提供,**不应**包含在作业的 uber JAR 中。您可以把该作业 JAR 提交到已经运行的 Flink 集群,也可以轻松将其添加到 Flink 应用程序容器镜像中,而无需修改发行版。 +根据经验,我们**建议**将应用程序代码及其所有必需的依赖项打包进一个 fat/uber JAR 中。这包括打包你作业用到的连接器、格式和第三方依赖项。此规则**不适用于** Java API、DataStream Scala API 以及前面提到的运行时模块,它们已经由 Flink 本身提供,**不应**包含在作业的 uber JAR 中。你可以把该作业 JAR 提交到已经运行的 Flink 集群,也可以轻松将其添加到 Flink 应用程序容器镜像中,而无需修改发行版。 +<a name="whats-next"></a> Review Comment: ```suggestion <a name="whats-next"></a> ``` ########## docs/content.zh/docs/dev/configuration/overview.md: ########## @@ -36,39 +36,44 @@ specific language governing permissions and limitations under the License. --> +<a name="project-configuration"></a> Review Comment: It's recommended that There should be an empty line between tag and the section title. ########## docs/content.zh/docs/dev/configuration/overview.md: ########## @@ -166,21 +184,23 @@ bash -c "$(curl https://flink.apache.org/q/gradle-quickstart.sh)" -- {{< version {{< /tab >}} {{< /tabs >}} +<a name="which-dependencies-do-you-need"></a> Review Comment: ```suggestion <a name="which-dependencies-do-you-need"></a> ``` -- 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. To unsubscribe, e-mail: issues-unsubscr...@flink.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org