[Document-3217][doc] Update readme.md

aiwenmo · Mar 1, 2024 · a37df2a · a37df2a
1 parent 9d06354
commit a37df2a
Show file tree

Hide file tree

Showing 16 changed files with 34 additions and 105 deletions.
diff --git a/README.md b/README.md
@@ -9,26 +9,24 @@
 
 ## Introduction
 
-Dinky is an out-of-the-box, one-stop, real-time computing platform dedicated to the construction and practice of Unified Streaming & Batch and Unified Data Lake & Data Warehouse. Based on Apache Flink, Dinky provides the ability to connect many big data frameworks including OLAP and Data Lake.
+Dinky is a real-time data development platform based on Apache Flink, enabling agile data development, deployment and operation.
 
 ## Feature
 
 Its main features are as follows:
 
-- Immersive Flink SQL Data Development: Dinky provides automatic prompt completion, syntax highlighting, statement beautification, online debugging, syntax verification, execution plan, MetaStore, lineage, version comparison, and more.
+- Immersive Flink SQL Data Development: Dinky provides prompt completion, statement beautification, online debugging, syntax verification, logic plan, catalog, lineage, version comparison, and more.
 - Support FlinkSQL multi-version development and execution modes: Dinky supports multiple development and execution modes for FlinkSQL, including Local, Standalone, Yarn/Kubernetes Session, Yarn Per-Job, and Yarn/Kubernetes Application.
-- Support FlinkSQL syntax enhancement: Dinky enhances FlinkSQL with features like database synchronization, execution environments, global variables, statement 
-  merging, table-valued aggregate functions, load dependency, and row-level permissions.
-- Supports real-time warehousing and lake entry of the entire FlinkCDC database, multi-database output, and automatic table creation.
-- Support SQL job development: You can develop SQL jobs for various databases, including ClickHouse, Doris, Hive, MySQL, Oracle, Phoenix, PostgreSQL, Presto, SQL Server, StarRocks, and more.
-- Support real-time online debugging:preview Table, ChangeLog, statistical chart and UDF.
+- Support Flink ecosystem: Connector, FlinkCEP, FlinkCDC, Paimon, PyFlink
+- Support FlinkSQL syntax enhancement: Dinky enhances FlinkSQL with features like database synchronization, execution environments, global variables, table-valued aggregate functions, load dependency, row-level permissions, and execute jar.
+- Support real-time warehousing and lake entry of the entire FlinkCDC database and FlinkCDC Pipeline task.
+- Support real-time online debugging: Preview Table, ChangeLog and UDF.
 - Support Flink Catalog, data source metadata online query and management.
-- Support real-time task operation and maintenance: Online and offline, job information, cluster information, job snapshot, exception information, data map, data exploration, historical version, alarm record, etc.
-- Support as multi-version FlinkSQL Server and OpenApi capability.
-- Support real-time job alarm and alarm group: DingTalk, WeChat, Feishu, E-mail, etc.
+- Support real-time task operation and maintenance: Online and offline, job information, job log, version info, job snapshot, monitor, sql lineage, alarm record, etc.
+- Support real-time job alarm and alarm group: DingTalk, WeChat, Feishu, E-mail, SMS, Http etc.
 - Support automatically managed SavePoint/CheckPoint recovery and triggering mechanisms: latest, earliest, specified, etc.
-- Support resource management: Cluster instance, cluster configuration, jar, data source, alarm group, alarm instance, document, global variable, system configuration, etc.
-- Support enterprise-level management: multi-tenant, user, role, project space.
+- Support resource management: Cluster instance, cluster configuration, data source, alarm, document, global variable, git project, UDF, resource, system configuration, etc.
+- Support enterprise-level management: multi-tenant, user, role, token.
 - More hidden features await exploration by our users.
 
 ## Principle
@@ -39,35 +37,23 @@ Its main features are as follows:
 
 > FlinkSQL Studio
 
-![datastudio](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/070/datastudio.png)
+![datastudio](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/v1/datastudio.png)
 
 > Grammar Check
 
-![checksql](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/070/checksql.png)
+![checksql](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/v1/checksql.png)
 
 > Version Management
 
-![versiondiff](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/070/versiondiff.png)
+![versiondiff](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/v1/versiondiff.png)
 
 > lineage
 
-![lineage](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/070/lineage.png)
-
-> BI Charts
-
-![charts](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/070/charts.png)
-
-> Metadata Query
-
-![metadata](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/070/metadata.png)
+![lineage](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/v1/lineage.png)
 
 > Task Monitoring
 
-![monitor](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/070/monitor.png)
-
-> Job Information
-
-![jobinfo](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/070/jobinfo.png)
+![monitor](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/v1/monitor.png)
 
 ## Participate in Contributions
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/DataLinkDC/dinky/pulls)
@@ -80,22 +66,8 @@ Thank you to all the people who already contributed to Dinky!
 
 ## How to Deploy
 
-- The dev branch is the 0.8 reconstructed version, which is still unstable.
-
-- The 0.7 branch is the current stable version. Please use this branch for compilation and debugging.
-
 See [source code compilation](https://github.com/DataLinkDC/dinky/blob/dev/docs/docs/deploy_guide/compile.mdx) and [installation and deployment](https://github.com/DataLinkDC/dinky/blob/dev/docs/docs/deploy_guide/deploy.mdx) for details.
 
-## How to Upgrade
-
-Due to the numerous functionalities, there are several bugs and optimization points that need attention.. It is strongly recommended to use or upgrade to the latest version.
-
-Upgrade steps:
-
-(1) Upgrade the app: Replace all dependencies of latest Dinky.
-
-(2) Upgrade the DDL: Execute the relevant version upgrade statements in the sql/upgrade directory, and execute them in the order of the version numbers.
-
 ## Thanks
 
 Standing on the shoulders of giants, Dinky was born. For this we express our heartfelt thanks to all the open source software used and its communities! We also hope that we are not only beneficiaries of open source, but also contributors to open source. We also hope that partners who share our enthusiasm and belief in open source will join us in contributing to the open-source community.
@@ -106,7 +78,7 @@ Below is a partial list of acknowledgements:
 
 [FlinkCDC](https://github.com/ververica/flink-cdc-connectors)
 
-[Apache Flink Table Store](https://github.com/apache/flink-table-store)
+[Apache Paimon](https://github.com/apache/incubator-paimon)
 
 [Apache Dolphinscheduler](https://github.com/apache/dolphinscheduler)
 
@@ -142,14 +114,6 @@ Thanks to [JetBrains](https://www.jetbrains.com/?from=dlink) for providing a fre
 
 5.Follow the WeChat public account to get the latest official articles: [Dinky Open Source](https://mmbiz.qpic.cn/mmbiz_jpg/dyicwnSlTFTp6w4PuJruFaLV6uShCJDkzqwtnbQJrQ90yKDuuIC8tyMU5DK69XZibibx7EPPBRQ3ic81se5UQYs21g/0?wx_fmt=jpeg).
 
-6.Follow bilibili UP master (Shi Wen Mo A) to get the latest video teaching.
-
 ## Copyright
 
-Please refer to the [LICENSE](https://github.com/DataLinkDC/dinky/blob/dev/LICENSE) document.
-
-# Contributors
-
-<a href="https://github.com/DataLinkDC/dinky/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=DataLinkDC/dinky" />
-</a>
+Please refer to the [LICENSE](https://github.com/DataLinkDC/dinky/blob/dev/LICENSE) document.
diff --git a/README_zh_CN.md b/README_zh_CN.md
@@ -11,26 +11,24 @@
 
 ## 简介
 
-Dinky 是一个 `开箱即用` 、`易扩展` ，以 `Apache Flink` 为基础，连接 `OLAP` 和 `数据湖` 等众多框架的 `一站式` 实时计算平台，致力于 `流批一体` 和 `湖仓一体` 的探索与实践。
+Dinky 是一个基于 `Apache Flink` 的实时数据开发平台，实现了敏捷的数据开发、部署和运维。
 
 ## 功能
 
 其主要功能如下：
 
-- 沉浸式 FlinkSQL 数据开发：自动提示补全、语法高亮、语句美化、在线调试、语法校验、执行计划、MetaStore、血缘分析、版本对比等
+- FlinkSQL 数据开发：提示补全、语句美化、在线调试、逻辑校验、执行计划、Catalog、血缘分析、版本对比等
 - 支持 FlinkSQL 多版本开发及多种执行模式：Local、Standalone、Yarn/Kubernetes Session、Yarn Per-Job、Yarn/Kubernetes Application
-- 支持 Apache Flink 生态：Connector、FlinkCDC、Table Store 等
-- 支持 FlinkSQL 语法增强：整库同步、执行环境、全局变量、语句合并、表值聚合函数、加载依赖、行级权限等
-- 支持 FlinkCDC 整库实时入仓入湖、多库输出、自动建表
-- 支持 SQL 作业开发：ClickHouse、Doris、Hive、Mysql、Oracle、Phoenix、PostgreSql、Presto、SqlServer、StarRocks 等
-- 支持实时在线调试预览 Table、ChangeLog、Charts 和 UDF
+- 支持 Apache Flink 生态：CDC、Connector、FlinkCEP、FlinkCDC、Paimon、PyFlink 等
+- 支持 FlinkSQL 语法增强：整库同步、执行环境、全局变量、表值聚合、加载依赖、行级权限、执行Jar任务等
+- 支持 FlinkCDC 整库实时入仓入湖与 FlinkCDCPipeline 整库同步
+- 支持实时在线调试预览 Table、ChangeLog 和 UDF
 - 支持 Flink Catalog、数据源元数据在线查询及管理
-- 支持实时任务运维：上线下线、作业信息、集群信息、作业快照、异常信息、数据地图、数据探查、历史版本、报警记录等
-- 支持作为多版本 FlinkSQL Server 以及 OpenApi 的能力
-- 支持实时作业报警及报警组：钉钉、微信企业号、飞书、邮箱等
+- 支持实时任务运维：上线下线、作业信息、作业日志、版本信息、作业快照、监控、SQL 血缘、告警记录等
+- 支持实时作业报警及报警组：钉钉、企业微信、飞书、邮箱、短信、http 等
 - 支持自动托管的 SavePoint/CheckPoint 恢复及触发机制：最近一次、最早一次、指定一次等
-- 支持多种资源管理：集群实例、集群配置、Jar、数据源、报警组、报警实例、文档、全局变量、系统配置等
-- 支持企业级管理：多租户、用户、角色、项目空间
+- 支持多种资源管理：集群实例、集群配置、数据源、告警、文档、全局变量、Git 项目、UDF、资源、系统配置等
+- 支持企业级管理：多租户、用户、角色、菜单、令牌
 - 更多隐藏功能等待小伙伴们探索
 
 ## 原理
@@ -41,35 +39,23 @@ Dinky 是一个 `开箱即用` 、`易扩展` ，以 `Apache Flink` 为基础，
 
 > FlinkSQL Studio
 
-![datastudio](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/070/datastudio.png)
+![datastudio](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/v1/datastudio.png)
 
 > 语法检查
 
-![checksql](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/070/checksql.png)
+![checksql](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/v1/checksql.png)
 
 > 版本管理
 
-![versiondiff](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/070/versiondiff.png)
+![versiondiff](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/v1/versiondiff.png)
 
 > 血缘分析
 
-![lineage](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/070/lineage.png)
-
-> BI 图表
-
-![charts](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/070/charts.png)
-
-> 元数据查询
-
-![metadata](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/070/metadata.png)
+![lineage](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/v1/lineage.png)
 
 > 任务监控
 
-![monitor](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/070/monitor.png)
-
-> 作业信息
-
-![jobinfo](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/070/jobinfo.png)
+![monitor](https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/v1/monitor.png)
 
 ## 参与贡献
 
@@ -83,21 +69,8 @@ Dinky 是一个 `开箱即用` 、`易扩展` ，以 `Apache Flink` 为基础，
 
 ## 如何部署
 
-- dev 分支为 0.8 重构版，尚不稳定
-- 0.7 分支为当前稳定版，编译调试请使用该分支
-
 详见 [源码编译](https://github.com/DataLinkDC/dinky/blob/dev/docs/docs/deploy_guide/compile.mdx) 和 [安装部署](https://github.com/DataLinkDC/dinky/blob/dev/docs/docs/deploy_guide/deploy.mdx) 。
 
-## 如何升级
-
-由于功能较多，所以 bug 及优化点较多，强烈建议使用或升级到最新版本。
-
-升级步骤：
-
-（1）升级应用：替换最新 Dinky 所有依赖包；
-
-（2）升级 DDL：执行 sql/upgrade 目录下的相关版本升级语句，依次按照版本号顺序执行。
-
 ## 感谢
 
 站在巨人的肩膀上，Dinky 才得以诞生。对此我们对使用的所有开源软件及其社区表示衷心的感谢！我们也希望自己不仅是开源的受益者，也能成为开源的贡献者，也希望对开源有同样热情和信念的伙伴加入进来，一起为开源献出一份力！
@@ -108,7 +81,7 @@ Dinky 是一个 `开箱即用` 、`易扩展` ，以 `Apache Flink` 为基础，
 
 [FlinkCDC](https://github.com/ververica/flink-cdc-connectors)
 
-[Apache Flink Table Store](https://github.com/apache/flink-table-store)
+[Apache Paimon](https://github.com/apache/incubator-paimon)
 
 [Apache Dolphinscheduler](https://github.com/apache/dolphinscheduler)
 
@@ -140,18 +113,10 @@ Dinky 是一个 `开箱即用` 、`易扩展` ，以 `Apache Flink` 为基础，
 
 <img src="https://raw.githubusercontent.com/DataLinkDC/dinky/dev/images/main/dinkydingding.jpg" alt="dinkydingding" style="zoom:30%;" />
 
-4.进入微信用户社区群（推荐，添加微信号 `wenmo_ai` 邀请进群）和 QQ 用户社区群（**543709668**）交流，必须申请备注 “ Dinky + 企业名 + 职位”，
+4.进入微信用户社区群（推荐，添加微信号 `wenmo_ai` 邀请进群）和 QQ 用户社区群（**543709668**）交流，必须申请备注 “Dinky + 企业名 + 职位”，
 
 5.关注微信公众号获取官方最新文章：[Dinky 开源](https://mmbiz.qpic.cn/mmbiz_jpg/dyicwnSlTFTp6w4PuJruFaLV6uShCJDkzqwtnbQJrQ90yKDuuIC8tyMU5DK69XZibibx7EPPBRQ3ic81se5UQYs21g/0?wx_fmt=jpeg)
 
-6.关注 bilibili UP 主（是文末呀）获取最新视频教学
-
 ## 版权
 
 请参考 [LICENSE](https://github.com/DataLinkDC/dinky/blob/dev/LICENSE) 文件。
-
-# 贡献者
-
-<a href="https://github.com/DataLinkDC/dinky/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=DataLinkDC/dinky" />
-</a>
diff --git a/images/070/charts.png b/images/070/charts.png
diff --git a/images/070/checksql.png b/images/070/checksql.png
diff --git a/images/070/datastudio.png b/images/070/datastudio.png
diff --git a/images/070/jobinfo.png b/images/070/jobinfo.png
diff --git a/images/070/lineage.png b/images/070/lineage.png
diff --git a/images/070/metadata.png b/images/070/metadata.png
diff --git a/images/070/monitor.png b/images/070/monitor.png
diff --git a/images/070/versiondiff.png b/images/070/versiondiff.png
diff --git a/images/main/dinkydingding.jpg b/images/main/dinkydingding.jpg
diff --git a/images/v1/checksql.png b/images/v1/checksql.png
diff --git a/images/v1/datastudio.png b/images/v1/datastudio.png
diff --git a/images/v1/lineage.png b/images/v1/lineage.png
diff --git a/images/v1/monitor.png b/images/v1/monitor.png
diff --git a/images/v1/versiondiff.png b/images/v1/versiondiff.png