From 962fe4fd9b6746a5c9fa98997ec8c2fb3e4f0564 Mon Sep 17 00:00:00 2001 From: Zzm0809 <934230207@qq.com> Date: Sun, 31 Dec 2023 14:22:12 +0800 Subject: [PATCH] [Doc] Modify doc i18n and Added some docs (#2864) * Spotless Apply * modify doc label to i18n and added some docs and faq * modify faq position * change repo url * fix jump url * fix * fix * fix --------- Co-authored-by: Zzm0809 --- docs/docs/deploy_guide/_category_.json | 2 +- docs/docs/developer_guide/_category_.json | 2 +- .../contribution/_category_.json | 2 +- .../contribution/code_format.md | 53 ++++++ .../contribution/commit_code.md | 6 +- .../contribution/commit_message.md | 4 +- .../contribution/how_contribute.md | 8 +- .../developer_guide/contribution/issue.md | 2 +- docs/docs/developer_guide/local_debug.md | 12 +- docs/docs/extend/_category_.json | 2 +- .../extend/expand_statements/_category_.json | 2 +- .../extend/function_expansion/_category_.json | 2 +- docs/docs/faq.md | 42 ++++- docs/docs/get_started/_category_.json | 2 +- .../get_started/quick_start/_category_.json | 2 +- docs/docs/platform_intro/_category_.json | 2 +- .../Integration_practice/_category_.json | 2 +- docs/docs/practical_guide/_category_.json | 2 +- .../cdcsource_practice/_category_.json | 2 +- .../run_mode_practice/_category_.json | 2 +- .../scenario_practice/_category_.json | 2 +- docs/docs/thanks.md | 4 +- docs/docs/user_guide/_category_.json | 2 +- .../user_guide/auth_center/_category_.json | 2 +- .../user_guide/devops_center/_category_.json | 2 +- .../register_center/_category_.json | 2 +- .../register_center/alert/_category_.json | 2 +- docs/docs/user_guide/studio/_category_.json | 2 +- .../development_control/_category_.json | 2 +- .../user_guide/system_setting/_category_.json | 2 +- .../global_settings/_category_.json | 2 +- .../user_guide/udf_develop/_category_.json | 2 +- .../{how_to => quick_use}/Java&Scala.md | 0 .../{how_to => quick_use}/Python.md | 0 .../{how_to => quick_use}/_category_.json | 0 docs/docusaurus.config.js | 68 +++---- docs/i18n/en/code.json | 10 +- .../current.json | 2 +- .../current.json | 170 ++++++++--------- .../en/docusaurus-theme-classic/footer.json | 42 ++--- .../en/docusaurus-theme-classic/navbar.json | 52 +++--- docs/i18n/zh/code.json | 10 +- .../current.json | 2 +- .../current.json | 172 +++++++----------- .../zh/docusaurus-theme-classic/footer.json | 48 +++-- .../zh/docusaurus-theme-classic/navbar.json | 48 ++--- docs/package.json | 2 +- 47 files changed, 426 insertions(+), 379 deletions(-) create mode 100644 docs/docs/developer_guide/contribution/code_format.md rename docs/docs/user_guide/udf_develop/{how_to => quick_use}/Java&Scala.md (100%) rename docs/docs/user_guide/udf_develop/{how_to => quick_use}/Python.md (100%) rename docs/docs/user_guide/udf_develop/{how_to => quick_use}/_category_.json (100%) diff --git a/docs/docs/deploy_guide/_category_.json b/docs/docs/deploy_guide/_category_.json index ce65382e33..8b1f05fa20 100644 --- a/docs/docs/deploy_guide/_category_.json +++ b/docs/docs/deploy_guide/_category_.json @@ -1,4 +1,4 @@ { - "label": "安装部署", + "label": "deploy_guide", "position": 2 } diff --git a/docs/docs/developer_guide/_category_.json b/docs/docs/developer_guide/_category_.json index 5ae564ba7b..1ae7ef1a79 100644 --- a/docs/docs/developer_guide/_category_.json +++ b/docs/docs/developer_guide/_category_.json @@ -1,4 +1,4 @@ { - "label": "开发者指南", + "label": "developer_guide", "position": 12 } diff --git a/docs/docs/developer_guide/contribution/_category_.json b/docs/docs/developer_guide/contribution/_category_.json index 8e961fc8c4..5eb8872202 100644 --- a/docs/docs/developer_guide/contribution/_category_.json +++ b/docs/docs/developer_guide/contribution/_category_.json @@ -1,4 +1,4 @@ { - "label": "参与贡献", + "label": "contribution", "position": 1 } diff --git a/docs/docs/developer_guide/contribution/code_format.md b/docs/docs/developer_guide/contribution/code_format.md new file mode 100644 index 0000000000..2b8936806d --- /dev/null +++ b/docs/docs/developer_guide/contribution/code_format.md @@ -0,0 +1,53 @@ +--- +sidebar_position: 7 +position: 7 +id: code_format +title: 代码格式化 +--- + +:::info 简介 + +如果你在 Dinky 基础上进行了二次开发/bugfix/实现了新功能,并打算贡献到社区,基于代码格式化要求,你必须执行格式化代码,满足规范后方可被合并. + +但是在 Dinky 1.0.0 之后,格式化插件升级后要求 JDK 环境为 JDK 11,如果你的 JDK 环境为 JDK 8,那么则需要升级 JDK 环境/配置服务端格式化,否则无法使用格式化插件.你的 Pull Request 的代码检查结果将会失败,从而无法被合并 + +基于上述说明,下面介绍多种方式,如何执行格式化并满足格式化要求. +::: + +## 升级 JDK 环境 + +> 此为单个 JDK 环境的升级 + +Dinky 1.0.0 之后,全面支持 JDK 11,如果你的 JDK 环境为 JDK 8,那么可以选择升级 JDK 环境,具体 JDK11 的安装方式自行搜索即可. + +## JDK 环境并存 + +如果你需要有多个 JDK 环境,那么你可以通过以下方式来实现 JDK 环境并存: + +1. 下载 JDK 11 并安装.不需要配置环境变量,只需要在 IDEA 中配置即可.前提是你所需的 JDK 主版本非 JDK11, 如果你想要设置 JDK 11 为默认,那么可以自行配置环境变量. +2. 在 IDEA 打开的 Dinky 工程中配置 JDK 11,并勾选 Maven Profile 中的 `jdk11`,并刷新 Maven Profile,使其重新加载. +3. 找到 Maven => Dinky 根下的 插件 => 展开 spotless, 双击 spotless:apply ,等待格式化完成. + +## 无需多 JDK 环境 + +如果你只需要单个 JDK 环境，并且本地的 JDK 环境版本为 JDK 8, 不想升级 JDK 环境,那么你可以通过以下方式来实现: + +> 注意: 此操作需要在你提交本地代码到你的仓库前进行. + +1. 登录你的 GitHub 账号,转到 https://github.com/settings/tokens +2. 点击下图路径, 创建 token,并指定名称为 `FORMAT`,请注意大小写,创建完成之后请牢记该 Token 值, 后续将会用到 +![create_token](http://pic.dinky.org.cn/dinky/docs/zh-CN/developer_guide/contribution/code_format/create_token.png) +3. 打开你的 GitHub 中 Fork 的 Dinky 仓库 -> Settings -> Secrets and variables -> Actions +![secrets_url](http://pic.dinky.org.cn/dinky/docs/zh-CN/developer_guide/contribution/code_format/secrets_url.png) +4. 点击 Secrets Tag -> New repository secret -> 名称指定为 `TOKEN` , 粘贴你在第一步中创建的 token 值, 点击 Add secret +5. 点击 Variables -> New repository variable -> 名称指定为 `FORMAT` , 值为`true`, 点击 Add variable +![variables_url](http://pic.dinky.org.cn/dinky/docs/zh-CN/developer_guide/contribution/code_format/variables_url.png) + +6. 基于此方式,可以一劳永逸,无需在 IDEA 中手动执行格式化,并无需安装 JDK 11 环境. 只需要正常修改/新增代码 -> 提交到你的 Dinky 仓库即可,服务端会自动执行格式化,并将结果反馈在 下图所示的 Actions 界面中. +![show_actions](http://pic.dinky.org.cn/dinky/docs/zh-CN/developer_guide/contribution/code_format/show_actions.png) + +:::tip 提示 + +以上为几种如何实现格式化的方案, 请根据你的实际情况选择合适的方式.推荐使用 [无需多 JDK 环境](#无需多-jdk-环境) 的方式,因为它更加方便,而且不会影响你的本地环境. + +::: \ No newline at end of file diff --git a/docs/docs/developer_guide/contribution/commit_code.md b/docs/docs/developer_guide/contribution/commit_code.md index 5b06f5872d..8409439b70 100644 --- a/docs/docs/developer_guide/contribution/commit_code.md +++ b/docs/docs/developer_guide/contribution/commit_code.md @@ -9,7 +9,7 @@ title: 提交代码须知 # 提交代码 -* 首先从远端仓库 *https://github.com/DataLinkDC/dlink.git* fork 一份代码到自己的仓库中 +* 首先从远端仓库 *https://github.com/DataLinkDC/dinky.git* fork 一份代码到自己的仓库中 * 远端仓库中分支： * dev 日常开发分支: 日常 dev 开发分支，新提交的代码都可以 pull request 到这个分支上。 @@ -19,13 +19,13 @@ title: 提交代码须知 * 把自己仓库 clone 到本地 ```sh - git clone https://github.com/DataLinkDC/dlink.git + git clone https://github.com/DataLinkDC/dinky.git ``` * 添加远端仓库地址，命名为 upstream ```sh - git remote add upstream https://github.com/DataLinkDC/dlink.git + git remote add upstream https://github.com/DataLinkDC/dinky.git ``` diff --git a/docs/docs/developer_guide/contribution/commit_message.md b/docs/docs/developer_guide/contribution/commit_message.md index cd87293e5a..fe00ba00c5 100644 --- a/docs/docs/developer_guide/contribution/commit_message.md +++ b/docs/docs/developer_guide/contribution/commit_message.md @@ -1,6 +1,6 @@ --- -sidebar_position: 3 -position: 3 +sidebar_position: 4 +position: 4 id: commit_message title: Commit Message 须知 --- diff --git a/docs/docs/developer_guide/contribution/how_contribute.md b/docs/docs/developer_guide/contribution/how_contribute.md index 46b12166da..43d812df6a 100644 --- a/docs/docs/developer_guide/contribution/how_contribute.md +++ b/docs/docs/developer_guide/contribution/how_contribute.md @@ -1,6 +1,6 @@ --- -sidebar_position: 4 -position: 4 +sidebar_position: 6 +position: 6 id: how_contribute title: 如何贡献 --- @@ -13,8 +13,8 @@ title: 如何贡献 我们鼓励任何形式的参与社区，如： -- 将遇到的问题通过 github 上 [issue](https://github.com/DataLinkDC/dlink/issues) 的形式反馈出来 -- 回答别人遇到的 [issue](https://github.com/DataLinkDC/dlink/issues) 问题 +- 将遇到的问题通过 github 上 [issue](https://github.com/DataLinkDC/dinky/issues) 的形式反馈出来 +- 回答别人遇到的 [issue](https://github.com/DataLinkDC/dinky/issues) 问题 - 讨论新 Feature 的实现方案 - 帮助完善文档及官网 - 帮助项目增加测试用例 diff --git a/docs/docs/developer_guide/contribution/issue.md b/docs/docs/developer_guide/contribution/issue.md index b92d9480ff..7d736e2763 100644 --- a/docs/docs/developer_guide/contribution/issue.md +++ b/docs/docs/developer_guide/contribution/issue.md @@ -51,7 +51,7 @@ Issue 是引出一个 Feature 或 Bug 等的重要步骤，在单个 Issue 中 ### Issue 内容模板 -[Issue 模板](https://github.com/DataLinkDC/dlink/tree/dev/.github/ISSUE_TEMPLATE) +[Issue 模板](https://github.com/DataLinkDC/dinky/tree/dev/.github/ISSUE_TEMPLATE) ### Bug 类 Issue diff --git a/docs/docs/developer_guide/local_debug.md b/docs/docs/developer_guide/local_debug.md index 692b50a451..6ce1e28f81 100644 --- a/docs/docs/developer_guide/local_debug.md +++ b/docs/docs/developer_guide/local_debug.md @@ -43,7 +43,7 @@ title: 本地调试 ```shell mkdir workspace cd workspace -git clone https://github.com/DataLinkDC/dlink.git +git clone https://github.com/DataLinkDC/dinky.git #或者 git clone git://github.com/DataLinkDC/dlink.git ``` @@ -51,7 +51,7 @@ git clone git://github.com/DataLinkDC/dlink.git ### 导入 Dinky 1. 启动 IDEA 并选择 Open。 -2. 选择已克隆的 Dlink 存储库的根文件夹。 +2. 选择已克隆的 Dinky 存储库的根文件夹。 3. 等待项目加载完成。 4. 设置 JDK 1.8 和 Maven 3.6.0。 @@ -90,7 +90,7 @@ npm run dev 由于目前 Dinky 各个模块未发布到 Maven 中央仓库，所以需要先进行 Install 编译。从而在本地仓库中生成相应的依赖。 -如果你是第一次编译 Dinky，那么请勾选以下 Maven Profile,然后双击下图中的`生命周期 -> Install`进行编译。 +如果你是第一次编译 Dinky，那么请勾选以下 Maven Profile,然后双击下图中的`生命周期 -> Install`进行编译。如果在 Install/Package 过程中报错代码格式化问题,请参考 [代码格式化](contribution/code_format)章节 ::: ![localdebug_profile](http://pic.dinky.org.cn/dinky/docs/zh-CN/developer_guide/local_debug/localdebug_profile.png) @@ -129,7 +129,7 @@ npm run dev Dinky开发环境配置有两种模式，分别是 provided 环境和 compile 环境 - provided：即上述 Profile 中的 `prod` ,此环境适合打包部署，或者二次开发后打包部署 -- compile： 即上述 Profile 中的 `dev`,此环境适合二次开发或者熟悉源码，此模式不需要额外安装Flink,通过Flink自带的local模式变可调试开发 +- compile： 即上述 Profile 中的 `dev`,此环境适合二次开发或者熟悉源码，此模式不需要额外安装Flink,通过Flink自带的local模式便可调试开发 ### 本地调试 Profile @@ -220,3 +220,7 @@ spring: 如果你在 Dinky 的基础上进行了二次开发,并有意向将代码贡献给 Dinky,请参考 [代码贡献](./contribution/how_contribute) 文档。 ::: + +## 常见问题 + +请参考 [本地调试 FAQ](../faq#本地调试FAQ) 文档。 \ No newline at end of file diff --git a/docs/docs/extend/_category_.json b/docs/docs/extend/_category_.json index 361184e375..4f75863a25 100644 --- a/docs/docs/extend/_category_.json +++ b/docs/docs/extend/_category_.json @@ -1,4 +1,4 @@ { - "label": "扩展", + "label": "extend", "position": 13 } diff --git a/docs/docs/extend/expand_statements/_category_.json b/docs/docs/extend/expand_statements/_category_.json index c2354fa070..37138fcbd9 100644 --- a/docs/docs/extend/expand_statements/_category_.json +++ b/docs/docs/extend/expand_statements/_category_.json @@ -1,4 +1,4 @@ { - "label": "扩展语法", + "label": "extended_grammar", "position": 2 } diff --git a/docs/docs/extend/function_expansion/_category_.json b/docs/docs/extend/function_expansion/_category_.json index 3cc459fe9e..b0f85c36c2 100644 --- a/docs/docs/extend/function_expansion/_category_.json +++ b/docs/docs/extend/function_expansion/_category_.json @@ -1,4 +1,4 @@ { - "label": "功能扩展", + "label": "function_extension", "position": 2 } diff --git a/docs/docs/faq.md b/docs/docs/faq.md index bcc79870ae..51f272004b 100644 --- a/docs/docs/faq.md +++ b/docs/docs/faq.md @@ -15,7 +15,7 @@ Caused by: java.lang.IllegalArgumentException: java.net.UnknownHostException: na ``` 提供 3 种方式解决这个问题： -- 升级 Dinky 至 0.6.2 及后续版本。详见：[https://github.com/DataLinkDC/dlink/issues/310](https://github.com/DataLinkDC/dlink/issues/310) +- 升级 Dinky 至 0.6.2 及后续版本。详见：[https://github.com/DataLinkDC/dinky/issues/310](https://github.com/DataLinkDC/dinky/issues/310) - 修改 `/etc/profile`，添加 HADOOP_HOME 环境变量 ```shell @@ -175,4 +175,42 @@ Cannot map checkpoint/savepoint state for operator xxx to the new program, becau If you want to allow to skip this, you can set the --allowNonRestoredState option on the CLI. ``` -添加参数 execution.savepoint.ignore-unclaimed-state:true，跳过无法还原的算子 \ No newline at end of file +添加参数 execution.savepoint.ignore-unclaimed-state:true，跳过无法还原的算子 + + +## 本地调试FAQ + + +Q1: 为什么不支持除了 Java8 和 Java11 以外的其他版本呢？ + +> A1: 因为 Flink 目前仅支持 Java8 和 Java11。 + +--- + +Q2: 为什么 Maven Profile 切换了不生效呢?? 提交任务时还是报各种依赖问题,Profile 像是不生效呢????? + +> A2-1: 因为你没刷新 Maven Profile，导致不生效 + +> A2-2: 因为虽然你刷新了 Maven Profile, 没重启 Dinky 服务(不要问为什么需要重启,这是一个开发人员的基本认知),导致依赖没包含在当前已启动的服务中. + +> A2-3: Profile 切的不对,注意灰色的 Profile 选项.请仔细仔细仔细仔细的看看. + +> A2-4: 查看你的 IDEA 的版本,不要太旧,尽量保持在 2022.x 以上(别问为什么,上边已经说了) + +> A2-5: Profile 切换加载,基于依赖的 ``标签属性声明 ,如果不懂,自行百度/谷歌/CSDN/StackOverFlow/ChatGPT + +--- + +Q3: 我在 IDEA 中启动 Dinky 后, 前端页面访问不了, 报错找不到页面?????? + +> A3-1: 可以在执行 Install 阶段勾选 `web` Profile,不然 dinky-admin/src/main/resources/ 下没有静态资源文件目录 `static`. + +> A3-2: 可以单独启动前端,参考 [本地调试-启动前端](developer_guide/local_debug#启动前端) 部分 + +--- + +Q4: 为什么在 IDEA 中启动 Dinky 后，Profile 也加载了,我用到了一个 connector 仍然报错找不到类????? + +> A4-1: Dinky 只加载了 Dinky 在开发中过程中用到的相关 Flink 依赖以及 Flink 的基本环境依赖.如报此类错误,请检查你的 pom.xml 文件,是否包含了 connector 所依赖的 jar 包 + +> A4-2: 如上述问题未解决,请检查你的 `dinky-flink` 模块下的与你Flink 版本一致的 `pom.xml` 文件,是否包含了 connector 所依赖的 jar 包 diff --git a/docs/docs/get_started/_category_.json b/docs/docs/get_started/_category_.json index c826d665db..7e9c3474af 100644 --- a/docs/docs/get_started/_category_.json +++ b/docs/docs/get_started/_category_.json @@ -1,4 +1,4 @@ { - "label": "快速开始", + "label": "get_started", "position": 1 } diff --git a/docs/docs/get_started/quick_start/_category_.json b/docs/docs/get_started/quick_start/_category_.json index 8196c81fc3..465a0b74c3 100644 --- a/docs/docs/get_started/quick_start/_category_.json +++ b/docs/docs/get_started/quick_start/_category_.json @@ -1,4 +1,4 @@ { - "label": "SQL 快速入门", + "label": "quick_start", "position": 3 } diff --git a/docs/docs/platform_intro/_category_.json b/docs/docs/platform_intro/_category_.json index 568e2319c3..aada6d5e89 100644 --- a/docs/docs/platform_intro/_category_.json +++ b/docs/docs/platform_intro/_category_.json @@ -1,4 +1,4 @@ { - "label": "Dinky 介绍", + "label": "platform_intro", "position": 0 } diff --git a/docs/docs/practical_guide/Integration_practice/_category_.json b/docs/docs/practical_guide/Integration_practice/_category_.json index c4b9b8a5d5..06bc2fa7a5 100644 --- a/docs/docs/practical_guide/Integration_practice/_category_.json +++ b/docs/docs/practical_guide/Integration_practice/_category_.json @@ -1,4 +1,4 @@ { - "label": "集成实践", + "label": "Integration_practice", "position": 4 } diff --git a/docs/docs/practical_guide/_category_.json b/docs/docs/practical_guide/_category_.json index 407de42c01..d0d469a2a9 100644 --- a/docs/docs/practical_guide/_category_.json +++ b/docs/docs/practical_guide/_category_.json @@ -1,4 +1,4 @@ { - "label": "实践指南", + "label": "practical_guide", "position": 9 } diff --git a/docs/docs/practical_guide/cdcsource_practice/_category_.json b/docs/docs/practical_guide/cdcsource_practice/_category_.json index 74594d8a57..9e87ca204b 100644 --- a/docs/docs/practical_guide/cdcsource_practice/_category_.json +++ b/docs/docs/practical_guide/cdcsource_practice/_category_.json @@ -1,4 +1,4 @@ { - "label": "整库同步实践", + "label": "cdcsource_practice", "position": 1 } diff --git a/docs/docs/practical_guide/run_mode_practice/_category_.json b/docs/docs/practical_guide/run_mode_practice/_category_.json index 5a0c0083a1..a031bcf81d 100644 --- a/docs/docs/practical_guide/run_mode_practice/_category_.json +++ b/docs/docs/practical_guide/run_mode_practice/_category_.json @@ -1,4 +1,4 @@ { - "label": "Flink模式提交实践", + "label": "run_mode_practice", "position": 2 } diff --git a/docs/docs/practical_guide/scenario_practice/_category_.json b/docs/docs/practical_guide/scenario_practice/_category_.json index 5cbc7266f1..90b905602e 100644 --- a/docs/docs/practical_guide/scenario_practice/_category_.json +++ b/docs/docs/practical_guide/scenario_practice/_category_.json @@ -1,4 +1,4 @@ { - "label": "场景实践", + "label": "scenario_practice", "position": 3 } diff --git a/docs/docs/thanks.md b/docs/docs/thanks.md index 7cf7b606b8..f2ef469c3c 100644 --- a/docs/docs/thanks.md +++ b/docs/docs/thanks.md @@ -44,8 +44,8 @@ title: 致谢 - Sa-Token 是一款简单易用、功能强大的Java权限认证框架。它提供了一套简单、灵活、高效的权限认证方案，帮助开发者更方便地进行权限认证。Dinky 项目的登录认证功能/权限控制基于 Sa-Token 实现。 -[![JetBrains](http://pic.dinky.org.cn/dinky/docs/zh-CN/thanks/jetbrains.svg)](https://www.jetbrains.com/?from=dlink) -此外，特别感谢 [JetBrains](https://www.jetbrains.com/?from=dlink) 提供的免费开源 License 赞助,JetBrains是一家软件开发工具提供商，提供了许多受欢迎的集成开发环境，如 IntelliJ IDEA。他们支持开源社区，为一些开源项目提供免费的开源许可证，以促进软件开发的进步 +[![JetBrains](http://pic.dinky.org.cn/dinky/docs/zh-CN/thanks/jetbrains.svg)](https://www.jetbrains.com/?from=dinky) +此外，特别感谢 [JetBrains](https://www.jetbrains.com/?from=dinky) 提供的免费开源 License 赞助,JetBrains是一家软件开发工具提供商，提供了许多受欢迎的集成开发环境，如 IntelliJ IDEA。他们支持开源社区，为一些开源项目提供免费的开源许可证，以促进软件开发的进步 ### 贡献者 diff --git a/docs/docs/user_guide/_category_.json b/docs/docs/user_guide/_category_.json index bdb28d864b..577cb5d6c1 100644 --- a/docs/docs/user_guide/_category_.json +++ b/docs/docs/user_guide/_category_.json @@ -1,4 +1,4 @@ { - "label": "使用手册", + "label": "user_guide", "position": 10 } diff --git a/docs/docs/user_guide/auth_center/_category_.json b/docs/docs/user_guide/auth_center/_category_.json index 4823caa35f..461ab11d78 100644 --- a/docs/docs/user_guide/auth_center/_category_.json +++ b/docs/docs/user_guide/auth_center/_category_.json @@ -1,4 +1,4 @@ { - "label": "认证中心", + "label": "auth_center", "position": 4 } diff --git a/docs/docs/user_guide/devops_center/_category_.json b/docs/docs/user_guide/devops_center/_category_.json index df230944fb..63052e4185 100644 --- a/docs/docs/user_guide/devops_center/_category_.json +++ b/docs/docs/user_guide/devops_center/_category_.json @@ -1,4 +1,4 @@ { - "label": "运维中心", + "label": "devops_center", "position": 2 } diff --git a/docs/docs/user_guide/register_center/_category_.json b/docs/docs/user_guide/register_center/_category_.json index 2f8469247c..f33ec35441 100644 --- a/docs/docs/user_guide/register_center/_category_.json +++ b/docs/docs/user_guide/register_center/_category_.json @@ -1,4 +1,4 @@ { - "label": "注册中心", + "label": "register_center", "position": 3 } diff --git a/docs/docs/user_guide/register_center/alert/_category_.json b/docs/docs/user_guide/register_center/alert/_category_.json index 8284503412..67be203d96 100644 --- a/docs/docs/user_guide/register_center/alert/_category_.json +++ b/docs/docs/user_guide/register_center/alert/_category_.json @@ -1,4 +1,4 @@ { - "label": "告警", + "label": "alert", "position": 3 } diff --git a/docs/docs/user_guide/studio/_category_.json b/docs/docs/user_guide/studio/_category_.json index ad5f36c8c8..0faec5ba02 100644 --- a/docs/docs/user_guide/studio/_category_.json +++ b/docs/docs/user_guide/studio/_category_.json @@ -1,4 +1,4 @@ { - "label": "数据开发", + "label": "studio", "position": 1 } diff --git a/docs/docs/user_guide/studio/development_control/_category_.json b/docs/docs/user_guide/studio/development_control/_category_.json index a9939a6d63..eeefbe8be1 100644 --- a/docs/docs/user_guide/studio/development_control/_category_.json +++ b/docs/docs/user_guide/studio/development_control/_category_.json @@ -1,4 +1,4 @@ { - "label": "基本介绍", + "label": "development_control", "position": 1 } diff --git a/docs/docs/user_guide/system_setting/_category_.json b/docs/docs/user_guide/system_setting/_category_.json index d190276aac..106055d472 100644 --- a/docs/docs/user_guide/system_setting/_category_.json +++ b/docs/docs/user_guide/system_setting/_category_.json @@ -1,4 +1,4 @@ { - "label": "配置中心", + "label": "system_setting", "position": 5 } diff --git a/docs/docs/user_guide/system_setting/global_settings/_category_.json b/docs/docs/user_guide/system_setting/global_settings/_category_.json index dcbfb13827..f06d46d152 100644 --- a/docs/docs/user_guide/system_setting/global_settings/_category_.json +++ b/docs/docs/user_guide/system_setting/global_settings/_category_.json @@ -1,4 +1,4 @@ { - "label": "全局配置", + "label": "global_settings", "position": 1 } diff --git a/docs/docs/user_guide/udf_develop/_category_.json b/docs/docs/user_guide/udf_develop/_category_.json index d7c7e7c3e3..0d2b50bff8 100644 --- a/docs/docs/user_guide/udf_develop/_category_.json +++ b/docs/docs/user_guide/udf_develop/_category_.json @@ -1,4 +1,4 @@ { - "label": "函数开发", + "label": "udf_develop", "position": 10 } diff --git a/docs/docs/user_guide/udf_develop/how_to/Java&Scala.md b/docs/docs/user_guide/udf_develop/quick_use/Java&Scala.md similarity index 100% rename from docs/docs/user_guide/udf_develop/how_to/Java&Scala.md rename to docs/docs/user_guide/udf_develop/quick_use/Java&Scala.md diff --git a/docs/docs/user_guide/udf_develop/how_to/Python.md b/docs/docs/user_guide/udf_develop/quick_use/Python.md similarity index 100% rename from docs/docs/user_guide/udf_develop/how_to/Python.md rename to docs/docs/user_guide/udf_develop/quick_use/Python.md diff --git a/docs/docs/user_guide/udf_develop/how_to/_category_.json b/docs/docs/user_guide/udf_develop/quick_use/_category_.json similarity index 100% rename from docs/docs/user_guide/udf_develop/how_to/_category_.json rename to docs/docs/user_guide/udf_develop/quick_use/_category_.json diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 72952e990b..9918516415 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -143,7 +143,7 @@ const config = { docs: { sidebar: { hideable: true,// 是否隐藏侧边栏 | Whether to hide the sidebar in mobile - autoCollapseCategories: true, // 点击另一个分类时自动折叠当前分类 | Click another category will automatically collapse the current category + autoCollapseCategories: false, // 点击另一个分类时自动折叠当前分类 | Click another category will automatically collapse the current category } }, @@ -157,8 +157,7 @@ const config = { { to: '/', position: 'left', - label: '主页', - title: '主页', + label: 'home', activeBaseRegex: `^/$`, }, { @@ -169,46 +168,42 @@ const config = { { to: '/download/download', position: 'right', - label: '下载', + label: 'download', activeBaseRegex: `/download/`, }, { - label: '开发者指南', + label: 'developer_guide', to: '/docs/next/developer_guide/contribution/how_contribute', position: 'right', items: [ { - label: "如何参与", + label: "how_contribute", to: "/docs/next/developer_guide/contribution/how_contribute", }, { - label: "本地调试", + label: "local_debug", to: "/docs/next/developer_guide/local_debug", }, - { - label: "远程调试", - to: "/docs/next/developer_guide/remote_debug", - }, ], }, - { - to: '/blog', - position: 'right', - label: '博客', - // activeBaseRegex: `/*/`, - }, + // { + // to: '/blog', + // position: 'right', + // label: 'bolg', + // // activeBaseRegex: `/*/`, + // }, { type: 'localeDropdown', position: 'right', }, { href: 'https://github.com/DataLinkDC/dinky/issues/884', - label: 'FAQ', + label: 'faq', position: 'right', }, { href: 'https://github.com/orgs/DataLinkDC/projects/1', - label: 'Roadmap', + label: 'roadmap', position: 'right', }, { @@ -223,40 +218,36 @@ const config = { style: 'dark', links: [ { - title: 'Docs', + title: 'docs', items: [ { - label: '文档首页', + label: 'doc_home', to: '/docs/next/platform_intro/intro', }, { - label: 'Open Api', - to: '/docs/next/administrator_guide/studio/openapi', + label: 'openapi', + to: '/docs/next/user_guide/studio/openapi', }, ], }, { - title: 'Community', + title: 'community', items: [ { - label: 'Discussions', - href: 'https://github.com/DataLinkDC/dinky/discussions', - }, - { - label: 'Issue', + label: 'issue', href: 'https://github.com/DataLinkDC/dinky/issues', }, { - label: 'Pull Request', + label: 'pr', href: 'https://github.com/DataLinkDC/dinky/pulls', }, ], }, { - title: 'More', + title: 'more', items: [ { - label: 'GitHub', + label: 'github', href: 'https://github.com/DataLinkDC/dinky', } ], @@ -298,6 +289,19 @@ const config = { { quality: 70, max: 1030, // 最大缩放图片尺寸。 + options: { + // 图片加载失败时显示的图片 + // 默认的图片加载方式 + // 默认的图片加载方式 + loadType: 'default', + // 图片加载失败时显示的图片 + errorImg: 'Cannot load image', + // 图片加载失败时显示的图片 + errorType: 'default', + // 图片加载失败时显示的图片 + errorImgType: 'default', + // 图片加载失败时显示的图片 + }, min: 640, // 最小缩放图片尺寸。 如果原始值比这还低，会使用原图尺寸。 steps: 2, // 在 min 和 max 之间最多生成的图片数量（包含两端点） disableInDev: false, diff --git a/docs/i18n/en/code.json b/docs/i18n/en/code.json index ef5b1e11c3..6e0a11b880 100644 --- a/docs/i18n/en/code.json +++ b/docs/i18n/en/code.json @@ -5,7 +5,7 @@ }, "theme.ErrorPageContent.tryAgain": { "message": "Try again", - "description": "The label of the button to try again when the page crashed" + "description": "The label of the button to try again rendering when the React error boundary captures an error" }, "theme.NotFound.title": { "message": "Page Not Found", @@ -311,5 +311,13 @@ "theme.docs.paginator.next": { "message": "Next", "description": "The label used to navigate to the next doc" + }, + "theme.NavBar.navAriaLabel": { + "message": "Main", + "description": "The ARIA label for the main navigation" + }, + "theme.docs.sidebar.navAriaLabel": { + "message": "Docs sidebar", + "description": "The ARIA label for the sidebar navigation" } } diff --git a/docs/i18n/en/docusaurus-plugin-content-docs-download/current.json b/docs/i18n/en/docusaurus-plugin-content-docs-download/current.json index dd30528de7..c0bffb7845 100644 --- a/docs/i18n/en/docusaurus-plugin-content-docs-download/current.json +++ b/docs/i18n/en/docusaurus-plugin-content-docs-download/current.json @@ -1,6 +1,6 @@ { "version.label": { - "message": "Next", + "message": "1.0.0", "description": "The label for version current" } } diff --git a/docs/i18n/en/docusaurus-plugin-content-docs/current.json b/docs/i18n/en/docusaurus-plugin-content-docs/current.json index 937238a44a..bf4b4fd8e6 100644 --- a/docs/i18n/en/docusaurus-plugin-content-docs/current.json +++ b/docs/i18n/en/docusaurus-plugin-content-docs/current.json @@ -1,122 +1,110 @@ { "version.label": { - "message": "Next", + "message": "1.0.0", "description": "The label for version current" }, - "sidebar.tutorialSidebar.category.概念和架构": { - "message": "概念和架构", - "description": "The label for category 概念和架构 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.deploy_guide": { + "message": "Deploy Guide", + "description": "The label for category deploy_guide in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.编译和部署": { - "message": "编译和部署", - "description": "The label for category 编译和部署 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.studio": { + "message": "Data Studio", + "description": "The label for category studio in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.快速入门": { - "message": "快速入门", - "description": "The label for category 快速入门 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.development_control": { + "message": "Basic Introduction", + "description": "The label for category development_control in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.操作指南": { - "message": "操作指南", - "description": "The label for category 操作指南 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.devops_center": { + "message": "Devops Center", + "description": "The label for category devops_center in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.SQL 开发指南": { - "message": "SQL 开发指南", - "description": "The label for category SQL 开发指南 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.register_center": { + "message": "Register Center", + "description": "The label for category register_center in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.DDL 语句": { - "message": "DDL 语句", - "description": "The label for category DDL 语句 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.system_setting": { + "message": "Setting Center", + "description": "The label for category system_setting in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.DML 语句": { - "message": "DML 语句", - "description": "The label for category DML 语句 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.contribution": { + "message": "Contribution", + "description": "The label for category contribution in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.数据集成指南": { - "message": "数据集成指南", - "description": "The label for category 数据集成指南 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.extend": { + "message": "Extend", + "description": "The label for category extend in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.用户手册": { - "message": "用户手册", - "description": "The label for category 用户手册 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.function_extension": { + "message": "Function Extension", + "description": "The label for category function_extension in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.数据开发": { - "message": "数据开发", - "description": "The label for category 数据开发 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.practical_guide": { + "message": "Practical Guide", + "description": "The label for category practical_guide in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.基本介绍": { - "message": "基本介绍", - "description": "The label for category 基本介绍 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.get_started": { + "message": "Get Started", + "description": "The label for category get_started in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.运维中心": { - "message": "运维中心", - "description": "The label for category 运维中心 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.platform_intro": { + "message": "Dinky Intro", + "description": "The label for category platform_intro in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.注册中心": { - "message": "注册中心", - "description": "The label for category 注册中心 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.quick_start": { + "message": "SQL Quick Start", + "description": "The label for category quick_start in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.配置中心": { - "message": "配置中心", - "description": "The label for category 配置中心 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.cdcsource_practice": { + "message": "CDCSource Practice", + "description": "The label for category cdcsource_practice in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category. Connector": { - "message": " Connector", - "description": "The label for category Connector in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.run_mode_practice": { + "message": "Flink Mode Submission Practice", + "description": "The label for category run_mode_practice in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.开发者指南": { - "message": "开发者指南", - "description": "The label for category 开发者指南 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.scenario_practice": { + "message": "Scenario Practice", + "description": "The label for category scenario_practice in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.参与贡献": { - "message": "参与贡献", - "description": "The label for category 参与贡献 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.Integration_practice": { + "message": "Integration Practice", + "description": "The label for category Integration_practice in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.扩展": { - "message": "扩展", - "description": "The label for category 扩展 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.user_guide": { + "message": "Manual", + "description": "The label for category user_guide in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.功能扩展": { - "message": "功能扩展", - "description": "The label for category 功能扩展 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.alert": { + "message": "Alert", + "description": "The label for category alert in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.实践指南": { - "message": "实践指南", - "description": "The label for category 实践指南 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.auth_center": { + "message": "Auth Center", + "description": "The label for category auth_center in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.UDF 开发": { - "message": "UDF 开发", - "description": "The label for category UDF 开发 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.global_settings": { + "message": "Global Config", + "description": "The label for category global_settings in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.快速使用": { - "message": "快速使用", - "description": "The label for category 快速使用 in sidebar tutorialSidebar" - }, - "sidebar.tutorialSidebar.category.平台介绍": { - "message": "平台介绍", - "description": "The label for category 平台介绍 in sidebar tutorialSidebar" - }, - "sidebar.tutorialSidebar.category.快速开始": { - "message": "快速开始", - "description": "The label for category 快速开始 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.udf_develop": { + "message": "UDFFunction Develop", + "description": "The label for category udf_develop in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.Quick Start": { - "message": "Quick Start", - "description": "The label for category Quick Start in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.developer_guide": { + "message": "Developer Guide", + "description": "The label for category developer_guide in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.k8s 集成手册": { - "message": "k8s 集成手册", - "description": "The label for category k8s 集成手册 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.extended_grammar": { + "message": "Extended Grammar", + "description": "The label for category extended_grammar in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.部署指南": { - "message": "部署指南", - "description": "The label for category 部署指南 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.quick_use": { + "message": "Quick Use", + "description": "The label for category Quick Use in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.Flink SQL 开发指南": { - "message": "Flink SQL 开发指南", - "description": "The label for category Flink SQL 开发指南 in sidebar tutorialSidebar" - }, - "sidebar.tutorialSidebar.category.语法增强（扩展语法）": { - "message": "语法增强（扩展语法）", - "description": "The label for category 语法增强（扩展语法） in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.快速使用": { + "message": "快速使用", + "description": "The label for category 快速使用 in sidebar tutorialSidebar" } } diff --git a/docs/i18n/en/docusaurus-theme-classic/footer.json b/docs/i18n/en/docusaurus-theme-classic/footer.json index f0f162741c..1d596557c5 100644 --- a/docs/i18n/en/docusaurus-theme-classic/footer.json +++ b/docs/i18n/en/docusaurus-theme-classic/footer.json @@ -1,42 +1,42 @@ { - "link.title.Docs": { + "link.title.docs": { "message": "Docs", - "description": "The title of the footer links column with title=Docs in the footer" + "description": "The title of the footer links column with title=docs in the footer" }, - "link.title.Community": { + "link.title.community": { "message": "Community", - "description": "The title of the footer links column with title=Community in the footer" + "description": "The title of the footer links column with title=community in the footer" }, - "link.title.More": { + "link.title.more": { "message": "More", - "description": "The title of the footer links column with title=More in the footer" + "description": "The title of the footer links column with title=more in the footer" }, - "link.item.label.文档首页": { - "message": "文档首页", - "description": "The label of footer link with label=文档首页 linking to /docs/next/platform_intro/intro" + "link.item.label.doc_home": { + "message": "Doc Home", + "description": "The label of footer link with label=doc_home linking to /docs/next/platform_intro/intro" }, - "link.item.label.Open Api": { + "link.item.label.openapi": { "message": "Open Api", - "description": "The label of footer link with label=Open Api linking to /docs/next/administrator_guide/studio/openapi" + "description": "The label of footer link with label=openapi linking to /docs/next/user_guide/studio/openapi" }, - "link.item.label.Discussions": { - "message": "Discussions", - "description": "The label of footer link with label=Discussions linking to https://github.com/DataLinkDC/dlink/discussions" - }, - "link.item.label.Issue": { + "link.item.label.issue": { "message": "Issue", - "description": "The label of footer link with label=Issue linking to https://github.com/DataLinkDC/dlink/issues" + "description": "The label of footer link with label=issue linking to https://github.com/DataLinkDC/dinky/issues" }, - "link.item.label.Pull Request": { + "link.item.label.pr": { "message": "Pull Request", - "description": "The label of footer link with label=Pull Request linking to https://github.com/DataLinkDC/dlink/pulls" + "description": "The label of footer link with label=pr linking to https://github.com/DataLinkDC/dinky/pulls" }, - "link.item.label.GitHub": { + "link.item.label.github": { "message": "GitHub", - "description": "The label of footer link with label=GitHub linking to https://github.com/DataLinkDC/dlink" + "description": "The label of footer link with label=github linking to https://github.com/DataLinkDC/dinky" }, "copyright": { "message": "Copyright © 2022 Dinky, Inc. DataLinkDC.
鲁ICP备20001630号-2", "description": "The footer copyright" + }, + "logo.alt": { + "message": "Dinky", + "description": "The alt text of footer logo" } } diff --git a/docs/i18n/en/docusaurus-theme-classic/navbar.json b/docs/i18n/en/docusaurus-theme-classic/navbar.json index 0fe2093021..5a4a3d1b04 100644 --- a/docs/i18n/en/docusaurus-theme-classic/navbar.json +++ b/docs/i18n/en/docusaurus-theme-classic/navbar.json @@ -3,44 +3,40 @@ "message": "Dinky", "description": "The title in the navbar" }, - "item.label.主页": { - "message": "主页", - "description": "Navbar item with label 主页" + "item.label.home": { + "message": "Home", + "description": "Navbar item with label home" }, - "item.label.下载": { - "message": "下载", - "description": "Navbar item with label 下载" + "item.label.download": { + "message": "Download", + "description": "Navbar item with label download" }, - "item.label.开发者指南": { - "message": "开发者指南", - "description": "Navbar item with label 开发者指南" + "item.label.developer_guide": { + "message": "Developer Guide", + "description": "Navbar item with label developer_guide" }, - "item.label.FAQ": { + "item.label.faq": { "message": "FAQ", - "description": "Navbar item with label FAQ" + "description": "Navbar item with label faq" }, - "item.label.GitHub": { + "item.label.github": { "message": "GitHub", "description": "Navbar item with label GitHub" }, - "item.label.RoadMap": { - "message": "RoadMap", - "description": "Navbar item with label GitHub" - }, - "item.label.如何参与": { - "message": "如何参与", - "description": "Navbar item with label 如何参与" - }, - "item.label.本地调试": { - "message": "本地调试", - "description": "Navbar item with label 本地调试" + "item.label.how_contribute": { + "message": "How to Contribute", + "description": "Navbar item with label how_contribute" }, - "item.label.远程调试": { - "message": "远程调试", - "description": "Navbar item with label 远程调试" + "item.label.local_debug": { + "message": "Local Debug", + "description": "Navbar item with label local_debug" }, - "item.label.Roadmap": { + "item.label.roadmap": { "message": "Roadmap", - "description": "Navbar item with label Roadmap" + "description": "Navbar item with label roadmap" + }, + "logo.alt": { + "message": "Dinky", + "description": "The alt text of navbar logo" } } diff --git a/docs/i18n/zh/code.json b/docs/i18n/zh/code.json index b4815fd1a3..29f451d7af 100644 --- a/docs/i18n/zh/code.json +++ b/docs/i18n/zh/code.json @@ -5,7 +5,7 @@ }, "theme.ErrorPageContent.tryAgain": { "message": " 再试一次 ", - "description": "The label of the button to try again when the page crashed" + "description": "The label of the button to try again rendering when the React error boundary captures an error" }, "theme.NotFound.title": { "message": "找不到页面", @@ -307,5 +307,13 @@ "theme.IdealImageMessage.error": { "message": "出现错误，点击重试", "description": "When the image fails to load for unknown error" + }, + "theme.NavBar.navAriaLabel": { + "message": "主导航", + "description": "The ARIA label for the main navigation" + }, + "theme.docs.sidebar.navAriaLabel": { + "message": "文档侧边栏", + "description": "The ARIA label for the sidebar navigation" } } diff --git a/docs/i18n/zh/docusaurus-plugin-content-docs-download/current.json b/docs/i18n/zh/docusaurus-plugin-content-docs-download/current.json index dd30528de7..c0bffb7845 100644 --- a/docs/i18n/zh/docusaurus-plugin-content-docs-download/current.json +++ b/docs/i18n/zh/docusaurus-plugin-content-docs-download/current.json @@ -1,6 +1,6 @@ { "version.label": { - "message": "Next", + "message": "1.0.0", "description": "The label for version current" } } diff --git a/docs/i18n/zh/docusaurus-plugin-content-docs/current.json b/docs/i18n/zh/docusaurus-plugin-content-docs/current.json index 40f8a891ae..0f2fa790d9 100644 --- a/docs/i18n/zh/docusaurus-plugin-content-docs/current.json +++ b/docs/i18n/zh/docusaurus-plugin-content-docs/current.json @@ -1,146 +1,110 @@ { "version.label": { - "message": "Next", + "message": "1.0.0", "description": "The label for version current" }, - "sidebar.tutorialSidebar.category.概念和架构": { - "message": "概念和架构", - "description": "The label for category 概念和架构 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.deploy_guide": { + "message": "安装部署", + "description": "The label for category deploy_guide in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.编译和部署": { - "message": "编译和部署", - "description": "The label for category 编译和部署 in sidebar tutorialSidebar" - }, - "sidebar.tutorialSidebar.category.快速入门": { - "message": "快速入门", - "description": "The label for category 快速入门 in sidebar tutorialSidebar" - }, - "sidebar.tutorialSidebar.category.操作指南": { - "message": "操作指南", - "description": "The label for category 操作指南 in sidebar tutorialSidebar" - }, - "sidebar.tutorialSidebar.category.FlinkSQL 操作指南": { - "message": "FlinkSQL 操作指南", - "description": "The label for category FlinkSQL 操作指南 in sidebar tutorialSidebar" - }, - "sidebar.tutorialSidebar.category.SQL 开发指南": { - "message": "SQL 开发指南", - "description": "The label for category SQL 开发指南 in sidebar tutorialSidebar" - }, - "sidebar.tutorialSidebar.category.使用手册": { + "sidebar.tutorialSidebar.category.user_guide": { "message": "使用手册", - "description": "The label for category 使用手册 in sidebar tutorialSidebar" + "description": "The label for category user_guide in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.数据开发": { + "sidebar.tutorialSidebar.category.studio": { "message": "数据开发", - "description": "The label for category 数据开发 in sidebar tutorialSidebar" + "description": "The label for category studio in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.基本介绍": { + "sidebar.tutorialSidebar.category.development_control": { "message": "基本介绍", - "description": "The label for category 基本介绍 in sidebar tutorialSidebar" + "description": "The label for category development_control in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.Catalog 管理": { - "message": "Catalog 管理", - "description": "The label for category Catalog 管理 in sidebar tutorialSidebar" - }, - "sidebar.tutorialSidebar.category.运维中心": { + "sidebar.tutorialSidebar.category.devops_center": { "message": "运维中心", - "description": "The label for category 运维中心 in sidebar tutorialSidebar" - }, - "sidebar.tutorialSidebar.category.作业管理": { - "message": "作业管理", - "description": "The label for category 作业管理 in sidebar tutorialSidebar" - }, - "sidebar.tutorialSidebar.category.作业调优": { - "message": "作业调优", - "description": "The label for category 作业调优 in sidebar tutorialSidebar" + "description": "The label for category devops_center in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.作业监控": { - "message": "作业监控", - "description": "The label for category 作业监控 in sidebar tutorialSidebar" - }, - "sidebar.tutorialSidebar.category.注册中心": { + "sidebar.tutorialSidebar.category.register_center": { "message": "注册中心", - "description": "The label for category 注册中心 in sidebar tutorialSidebar" + "description": "The label for category register_center in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.配置中心": { + "sidebar.tutorialSidebar.category.system_setting": { "message": "配置中心", - "description": "The label for category 配置中心 in sidebar tutorialSidebar" + "description": "The label for category system_setting in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.扩展": { + "sidebar.tutorialSidebar.category.extend": { "message": "扩展", - "description": "The label for category 扩展 in sidebar tutorialSidebar" + "description": "The label for category extend in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.功能扩展": { + "sidebar.tutorialSidebar.category.function_extension": { "message": "功能扩展", - "description": "The label for category 功能扩展 in sidebar tutorialSidebar" + "description": "The label for category function_extension in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.实践指南": { + "sidebar.tutorialSidebar.category.practical_guide": { "message": "实践指南", - "description": "The label for category 实践指南 in sidebar tutorialSidebar" + "description": "The label for category practical_guide in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.开发者指南": { + "sidebar.tutorialSidebar.category.developer_guide": { "message": "开发者指南", - "description": "The label for category 开发者指南 in sidebar tutorialSidebar" + "description": "The label for category developer_guide in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.参与贡献": { + "sidebar.tutorialSidebar.category.contribution": { "message": "参与贡献", - "description": "The label for category 参与贡献 in sidebar tutorialSidebar" + "description": "The label for category contribution in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.DDL 语句": { - "message": "DDL 语句", - "description": "The label for category DDL 语句 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.quick_use": { + "message": "快速使用", + "description": "The label for category 快速使用 in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.DML 语句": { - "message": "DML 语句", - "description": "The label for category DML 语句 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.get_started": { + "message": "快速开始", + "description": "The label for category get_started in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.数据集成指南": { - "message": "数据集成指南", - "description": "The label for category 数据集成指南 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.platform_intro": { + "message": "Dinky 介绍", + "description": "The label for category platform_intro in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.用户手册": { - "message": "用户手册", - "description": "The label for category 用户手册 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.quick_start": { + "message": "SQL 快速入门", + "description": "The label for category quick_start in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category. Connector": { - "message": " Connector", - "description": "The label for category Connector in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.cdcsource_practice": { + "message": "整库同步实践", + "description": "The label for category cdcsource_practice in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.UDF 开发": { - "message": "UDF 开发", - "description": "The label for category UDF 开发 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.run_mode_practice": { + "message": "Flink模式提交实践", + "description": "The label for category run_mode_practice in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.快速使用": { - "message": "快速使用", - "description": "The label for category 快速使用 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.scenario_practice": { + "message": "场景实践", + "description": "The label for category scenario_practice in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.平台介绍": { - "message": "平台介绍", - "description": "The label for category 平台介绍 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.Integration_practice": { + "message": "集成实践", + "description": "The label for category Integration_practice in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.快速开始": { - "message": "快速开始", - "description": "The label for category 快速开始 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.alert": { + "message": "告警", + "description": "The label for category alert in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.Quick Start": { - "message": "Quick Start", - "description": "The label for category Quick Start in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.auth_center": { + "message": "认证中心", + "description": "The label for category auth_center in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.k8s 集成手册": { - "message": "k8s 集成手册", - "description": "The label for category k8s 集成手册 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.global_settings": { + "message": "全局配置", + "description": "The label for category global_settings in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.部署指南": { - "message": "部署指南", - "description": "The label for category 部署指南 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.udf_develop": { + "message": "函数开发", + "description": "The label for category udf_develop in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.Flink SQL 开发指南": { - "message": "Flink SQL 开发指南", - "description": "The label for category Flink SQL 开发指南 in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.extended_grammar": { + "message": "扩展语法", + "description": "The label for category extended_grammar in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.语法增强（扩展语法）": { - "message": "语法增强（扩展语法）", - "description": "The label for category 语法增强（扩展语法） in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.快速使用": { + "message": "快速使用", + "description": "The label for category 快速使用 in sidebar tutorialSidebar" } } diff --git a/docs/i18n/zh/docusaurus-theme-classic/footer.json b/docs/i18n/zh/docusaurus-theme-classic/footer.json index df0f355e56..9bdcaa5bc0 100644 --- a/docs/i18n/zh/docusaurus-theme-classic/footer.json +++ b/docs/i18n/zh/docusaurus-theme-classic/footer.json @@ -1,46 +1,42 @@ { - "link.title.Docs": { - "message": "Docs", - "description": "The title of the footer links column with title=Docs in the footer" + "link.title.docs": { + "message": "文档", + "description": "The title of the footer links column with title=docs in the footer" }, - "link.title.Community": { - "message": "Community", - "description": "The title of the footer links column with title=Community in the footer" + "link.title.community": { + "message": "社区", + "description": "The title of the footer links column with title=community in the footer" }, - "link.title.More": { - "message": "More", - "description": "The title of the footer links column with title=More in the footer" + "link.title.more": { + "message": "更多", + "description": "The title of the footer links column with title=more in the footer" }, - "link.item.label.文档首页": { + "link.item.label.doc_home": { "message": "文档首页", - "description": "The label of footer link with label=文档首页 linking to /docs/next/platform_intro/intro" + "description": "The label of footer link with label=doc_home linking to /docs/next/platform_intro/intro" }, - "link.item.label.Open Api": { + "link.item.label.openapi": { "message": "Open Api", - "description": "The label of footer link with label=Open Api linking to /docs/next/administrator_guide/studio/openapi" + "description": "The label of footer link with label=openapi linking to /docs/next/user_guide/studio/openapi" }, - "link.item.label.Discussions": { - "message": "Discussions", - "description": "The label of footer link with label=Discussions linking to https://github.com/DataLinkDC/dlink/discussions" - }, - "link.item.label.Issue": { + "link.item.label.issue": { "message": "Issue", - "description": "The label of footer link with label=Issue linking to https://github.com/DataLinkDC/dlink/issues" + "description": "The label of footer link with label=issue linking to https://github.com/DataLinkDC/dinky/issues" }, - "link.item.label.Pull Request": { + "link.item.label.pr": { "message": "Pull Request", - "description": "The label of footer link with label=Pull Request linking to https://github.com/DataLinkDC/dlink/pulls" + "description": "The label of footer link with label=pr linking to https://github.com/DataLinkDC/dinky/pulls" }, - "link.item.label.GitHub": { + "link.item.label.github": { "message": "GitHub", - "description": "The label of footer link with label=GitHub linking to https://github.com/DataLinkDC/dlink" + "description": "The label of footer link with label=github linking to https://github.com/DataLinkDC/dinky" }, "copyright": { "message": "Copyright © 2022 Dinky, Inc. DataLinkDC.
鲁ICP备20001630号-2", "description": "The footer copyright" }, - "link.item.label.博客": { - "message": "博客", - "description": "The label of footer link with label=最新动态 linking to /blog" + "logo.alt": { + "message": "Dinky", + "description": "The alt text of footer logo" } } diff --git a/docs/i18n/zh/docusaurus-theme-classic/navbar.json b/docs/i18n/zh/docusaurus-theme-classic/navbar.json index 16ec9fc974..4903d8f0f6 100644 --- a/docs/i18n/zh/docusaurus-theme-classic/navbar.json +++ b/docs/i18n/zh/docusaurus-theme-classic/navbar.json @@ -3,31 +3,27 @@ "message": "Dinky", "description": "The title in the navbar" }, - "item.label.主页": { + "item.label.home": { "message": "主页", "description": "Navbar item with label 主页" }, - "item.label.文档": { + "item.label.doc": { "message": "文档", "description": "Navbar item with label 文档" }, - "item.label.下载": { + "item.label.download": { "message": "下载", "description": "Navbar item with label 下载" }, - "item.label.开发者指南": { + "item.label.developer_guide": { "message": "开发者指南", "description": "Navbar item with label 开发者指南" }, - "item.label.GitHub": { + "item.label.github": { "message": "GitHub", "description": "Navbar item with label GitHub" }, - "item.label.RoadMap": { - "message": "RoadMap", - "description": "Navbar item with label GitHub" - }, - "item.label.Next": { + "item.label.next": { "message": "Next", "description": "Navbar item with label Next" }, @@ -43,36 +39,28 @@ "message": "All Versions", "description": "Navbar item with label All Versions" }, - "item.label.如何参与": { + "item.label.how_contribute": { "message": "如何参与", "description": "Navbar item with label 如何参与" }, - "item.label.本地调试": { + "item.label.local_debug": { "message": "本地调试", "description": "Navbar item with label 本地调试" }, - "item.label.远程调试": { - "message": "远程调试", - "description": "Navbar item with label 远程调试" - }, - "item.label.debug": { - "message": "debug", - "description": "Navbar item with label debug" - }, - "item.label.博客": { - "message": "博客", - "description": "Navbar item with label 博客" - }, "item.label.0.6": { "message": "0.6", "description": "Navbar item with label 0.6" }, - "item.label.FAQ": { - "message": "FAQ", - "description": "Navbar item with label FAQ" + "item.label.faq": { + "message": "常见问题", + "description": "Navbar item with label 常见问题" + }, + "item.label.roadmap": { + "message": "未来规划", + "description": "Navbar item with label 未来规划" }, - "item.label.Roadmap": { - "message": "Roadmap", - "description": "Navbar item with label Roadmap" + "logo.alt": { + "message": "Dinky", + "description": "The alt text of navbar logo" } } diff --git a/docs/package.json b/docs/package.json index f5f5dbfcb2..f7c5ee776f 100644 --- a/docs/package.json +++ b/docs/package.json @@ -12,7 +12,7 @@ "swizzle": "docusaurus swizzle", "serve": "docusaurus serve", "write-translations": "docusaurus write-translations --locale en && docusaurus write-translations --locale zh", - "write-heading-ids": "docusaurus write-heading-ids" + "write-heading-ids": "docusaurus write-heading-ids --overwrite" }, "dependencies": { "@docusaurus/core": "^2.2.0",