添加README中文和英文说明

TagawaAkirayo · Feb 10, 2022 · 674fa6e · 674fa6e
1 parent 9496062
commit 674fa6e
Show file tree

Hide file tree

Showing 5 changed files with 209 additions and 4 deletions.
diff --git a/README.en-US.md b/README.en-US.md
@@ -0,0 +1,39 @@
+<font size=7>[English](README.en-US.md)| 简体中文</font>
+# Dinky 
+Dinky是一个基于Apache Flink封装的一个可视化的、轻量级可交互式的Studio，可以在线开发、补全、校验 、执行、预览 FlinkSQL，支持 Flink 官方所有语法及其增强语法，并且可以同时对多 Flink 集群实例进行提交、停止、SavePoint 等运维操作。
+
+Learn more about Dinky at http://www.dlink.top
+
+## Main features
+## Compile  
+See [Compilation](https://github.com/DataLinkDC/dlink/blob/dev/docs/zh-CN/quick_start/build.md)
+## install
+See [install](https://github.com/DataLinkDC/dlink/blob/dev/docs/zh-CN/quick_start/deploy.md)
+## Technology
+[Apache Flink](https://github.com/apache/flink)
+
+[Mybatis Plus](https://github.com/baomidou/mybatis-plus)
+
+[ant-design-pro](https://github.com/ant-design/ant-design-pro)
+
+[Monaco Editor](https://github.com/Microsoft/monaco-editor)
+
+[SpringBoot]()
+
+## License
+## thanks
+Thanks to [JetBrains](https://www.jetbrains.com/?from=dlink) for sponsoring a free open source license
+
+[![JetBrains](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/main/jetbrains.svg)](https://www.jetbrains.com/?from=dlink)
+
+## recent plan
+
+1.Task Lifecycle Management
+
+2.Job monitoring and operation and maintenance
+
+3.Streaming Job Automatic Recovery
+
+4.Job log view
+
+5.Dingding alarm and push
diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -0,0 +1,124 @@
+<font size=7>English| [简体中文](README.zh-CN.md)</font>
+# Dinky 
+Dinky是一个基于Apache Flink封装的一个可视化的、轻量级可交互式的Studio，可以在线开发、补全、校验 、执行、预览 FlinkSQL，支持 Flink 官方所有语法及其增强语法，并且可以同时对多 Flink 集群实例进行提交、停止、SavePoint 等运维操作。
+
+了解更多有关Dinky的信息请查阅:http://www.dlink.top
+
+## 主要功能
+
+## 编译
+
+详见[编译](https://github.com/DataLinkDC/dlink/blob/dev/docs/zh-CN/quick_start/build.md)
+
+## 安装
+
+详见[安装](https://github.com/DataLinkDC/dlink/blob/dev/docs/zh-CN/quick_start/deploy.md)
+
+## 技术栈
+[Apache Flink](https://github.com/apache/flink)
+
+[Mybatis Plus](https://github.com/baomidou/mybatis-plus)
+
+[ant-design-pro](https://github.com/ant-design/ant-design-pro)
+
+[Monaco Editor](https://github.com/Microsoft/monaco-editor)
+
+[SpringBoot]()
+
+## License
+
+## 致谢
+感谢 [JetBrains](https://www.jetbrains.com/?from=dlink) 提供的免费开源 License 赞助
+
+[![JetBrains](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/main/jetbrains.svg)](https://www.jetbrains.com/?from=dlink)
+
+## 近期计划
+
+1.任务生命周期管理
+
+2.作业监控及运维
+
+3.流作业自动恢复
+
+4.作业日志查看
+
+5.钉钉报警和推送
+
+## 交流与贡献
+
+欢迎您加入社区交流分享，也欢迎您为社区贡献自己的力量。
+
+在此非常感谢大家的支持~
+
+QQ社区群：**543709668**，申请备注 “ Dinky ”，不写不批
+
+微信社区群（推荐）：添加微信号 wenmo_ai 邀请进群，申请备注 “ Dinky + 企业名 + 职位”，不写不批
+
+公众号（最新消息获取建议关注）：[DataLink数据中台](https://mmbiz.qpic.cn/mmbiz_jpg/dyicwnSlTFTp6w4PuJruFaLV6uShCJDkzqwtnbQJrQ90yKDuuIC8tyMU5DK69XZibibx7EPPBRQ3ic81se5UQYs21g/0?wx_fmt=jpeg)
+
+## 运行截图
+
+> 登录页
+
+![](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/050/050login.png)
+
+> 首页
+
+![](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/050/050home.png)
+
+> FlinkSQL Studio
+
+![](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/050/050flinksqlstudio.png)
+
+> 自动补全
+
+![](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/050/050autocomplete.png)
+
+> ChangeLog 预览
+
+![](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/050/050changelog.png)
+
+> BI 折线图
+
+![](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/050/050line.png)
+
+> Table 预览
+
+![](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/050/050table.png)
+
+> 语法校验和逻辑检查
+
+![](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/050/050check.png)
+
+> JobPlan 预览
+
+![](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/050/050jobplan.png)
+
+> FlinkSQL 导出
+
+![](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/050/050export.png)
+
+> 血缘分析
+
+![](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/050/050ca.png)
+
+> Savepoint 管理
+
+![](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/050/050savepoint.png)
+
+> 共享会话
+
+![](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/050/050session.png)
+
+> 元数据
+
+![](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/050/050metadata.png)
+
+> 集群实例
+
+![](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/050/050cluster.png)
+
+
+> 集群配置
+
+![](https://gitee.com/DataLinkDC/dlink/raw/main/dlink-doc/images/050/050clusterconf.png)
diff --git a/docs/_coverpage.md b/docs/_coverpage.md
@@ -11,4 +11,4 @@
 
 [GitHub](https://github.com/DataLinkDC/dlink)
 [Gitee](https://gitee.com/DataLinkDC/dlink)
-[Get Started](/guide/quickstart)
+[Get Started](/zh-CN/introduce)
diff --git a/docs/index.html b/docs/index.html
@@ -15,7 +15,7 @@
     window.$docsify = {
       name: 'Dinky',
       nameLink: {
-        '/': '/',
+        '/zh-CN/': '/zh-CN/',
         '/en-US/': '/en-US/',
       },
       repo: 'https://github.com/DataLinkDC/dlink',
@@ -26,11 +26,49 @@
       autoHeader: true,
       formatUpdated: '{MM}/{DD} {HH}:{mm}',
       ext: '.md',
-      loadNavbar: true
+      loadNavbar: true,
+      loadSidebar: true,
+      subMaxLevel: 4,
+      auto2top: true,
+      search: {
+            maxAge: 86400000, // 过期时间，单位毫秒，默认一天
+            paths: 'auto',
+            placeholder: '搜索',
+            noData: '没有记录！'
+          },
+            // 分页导航插件
+            pagination: {
+                previousText: '上一页',
+                nextText: '下一页',
+                crossChapter: true,
+                crossChapterText: true
+            },
+            // 文本高亮
+            'flexible-alerts': {
+                style: 'flat',
+                note: {
+                    label: "信息"
+                },
+                tip: {
+                    label: "提示"
+                },
+                warning: {
+                    label: "注意"
+                },
+                attention: {
+                    label: "切记"
+                }
+            },
+            sidebarDisplayLevel: 4,
     }
   </script>
   <!-- Docsify v4 -->
   <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
   <script src="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>
+  <script  src ="//cdn.jsdelivr.net/npm/docsify-sidebar-collapse/dist/docsify-sidebar-collapse.min.js"></script >
+  <script src="https://unpkg.com/docsify-plugin-flexible-alerts"></script>
+  <script src="//unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify-sidebar-collapse/dist/sidebar.min.css"/>
+  <script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
 </body>
 </html>
diff --git a/docs/zh-CN/quick_start/deploy.md b/docs/zh-CN/quick_start/deploy.md
@@ -153,7 +153,11 @@ mkdir plugins
 ```
 https://mvnrepository.com/artifact/org.apache.flink/flink-shaded-hadoop-3-uber?repo=cloudera-repos
 ```
-
+解压后结构如上所示，修改配置文件内容。lib 文件夹下存放 dlink 自身的扩展文件，plugins 文件夹下存放 flink 及 hadoop 的官方扩展文件（ 如果plugins下引入了flink-shaded-hadoop-3-uber 或者其他可能冲突的jar，请手动删除内部的 javax.servlet 等冲突内容）。其中 plugins 中的所有 jar 需要根据版本号自行下载并添加，才能体验完整功能，当然也可以放自己修改的 Flink 源码编译包。extends 文件夹只作为扩展插件的备份管理，不会被 dlink 加载。
+请检查 plugins 下是否添加了 flink 对应版本的 flink-dist,flink-table,flink-shaded-hadoop-3-uber 等如上所示的依赖！！！
+请检查 plugins 下是否添加了 flink 对应版本的 flink-dist,flink-table,flink-shaded-hadoop-3-uber 等如上所示的依赖！！！
+请检查 plugins 下是否添加了 flink 对应版本的 flink-dist,flink-table,flink-shaded-hadoop-3-uber 等如上所示的依赖！！！
+如果plugins下引入了flink-shaded-hadoop-3-uber 的jar，请手动删除内部的 javax.servlet 后既可以访问默认 8888 端口号（如127.0.0.1:8888），正常打开前端页面。
 如果是CDH及HDP使用开源flink-shade对Dlink没有任何影响，其他用到的依赖取决于CDH或者HDP与开源版本的兼容性，需要自行根据兼容性添加依赖即可正常使用 Dlink 的所有功能。
 
 ### 启动Dlink