From 0ec2afc9620ee612b6eb7637b10a1d72ea43bdab Mon Sep 17 00:00:00 2001 From: Shiwen Cheng Date: Fri, 5 Mar 2021 21:26:43 +0800 Subject: [PATCH] [1.3.6-prepare][Improvement][README] Update official website link in readme #4903 (#4967) --- .github/ISSUE_TEMPLATE/bug_report.md | 8 +- .github/ISSUE_TEMPLATE/feature_request.md | 10 +- .../ISSUE_TEMPLATE/improvement_suggestion.md | 23 +++++ .github/ISSUE_TEMPLATE/question.md | 12 +-- .github/PULL_REQUEST_TEMPLATE.md | 2 +- README.md | 95 ++++++++++--------- README_zh_CN.md | 56 +++++------ 7 files changed, 117 insertions(+), 89 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/improvement_suggestion.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dc797cf0a8..c8c90dc26a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,14 +1,12 @@ --- name: Bug report about: Create a report to help us improve -title: "[BUG] bug title " -labels: bug +title: "[Bug][Module Name] Bug title " assignees: '' --- -*For better global communication, please give priority to using English description, thx! * - +**For better global communication, Please describe it in English. If you feel the description in English is not clear, then you can append description in Chinese(just for Mandarin(CN)), thx! ** **Describe the bug** A clear and concise description of what the bug is. @@ -32,5 +30,5 @@ If applicable, add screenshots to help explain your problem. **Additional context** Add any other context about the problem here. -**Requirement or improvement +**Requirement or improvement** - Please describe about your requirements or improvement suggestions. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 8cd481d442..37aebf4a13 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,12 +1,18 @@ --- name: Feature request about: Suggest an idea for this project -title: "[Feature]" -labels: new feature +title: "[Feature][Module Name] Feature title" assignees: '' --- +*For better global communication, please give priority to using English description, thx! * + +*Please review https://dolphinscheduler.apache.org/en-us/community/development/issue.html when describe an issue.* + +**Describe the feature** +A clear and concise description of what the feature is. + **Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] diff --git a/.github/ISSUE_TEMPLATE/improvement_suggestion.md b/.github/ISSUE_TEMPLATE/improvement_suggestion.md new file mode 100644 index 0000000000..d01936b19d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improvement_suggestion.md @@ -0,0 +1,23 @@ +--- +name: Improvement suggestion +about: Improvement suggestion for this project +title: "[Improvement][Module Name] Improvement title" +assignees: '' + +--- + +*For better global communication, please give priority to using English description, thx! * + +*Please review https://dolphinscheduler.apache.org/en-us/community/development/issue.html when describe an issue.* + +**Describe the question** +A clear and concise description of what the improvement is. + +**What are the current deficiencies and the benefits of improvement** +- A clear and concise description of the current deficiencies and the benefits of this improvement. + +**Which version of DolphinScheduler:** + -[1.1.0-preview] + +**Describe alternatives you've considered** +A clear and concise description of any alternative improvement solutions you've considered. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 59c8ce7716..961d82476e 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -1,14 +1,12 @@ --- -name: question -about: have a question wanted to be help -title: "[QUESTION] question title" -labels: question +name: Question +about: Have a question wanted to be help +title: "[Question] Question title" assignees: '' --- -*For better global communication, please give priority to using English description, thx! * - +**For better global communication, Please describe it in English. If you feel the description in English is not clear, then you can append description in Chinese(just for Mandarin(CN)), thx! ** **Describe the question** A clear and concise description of what the question is. @@ -19,5 +17,5 @@ A clear and concise description of what the question is. **Additional context** Add any other context about the problem here. -**Requirement or improvement +**Requirement or improvement** - Please describe about your requirements or improvement suggestions. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6235a6ce84..c150c845c3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@ ## *Tips* - *Thanks very much for contributing to Apache DolphinScheduler.* -- *Please review https://dolphinscheduler.apache.org/en-us/community/index.html before opening a pull request.* +- *Please review https://dolphinscheduler.apache.org/en-us/community/development/pull-request.html before opening a pull request.* ## What is the purpose of the pull request diff --git a/README.md b/README.md index 97e1a95b18..0c933f642f 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,48 @@ Dolphin Scheduler Official Website [dolphinscheduler.apache.org](https://dolphinscheduler.apache.org) ============ + [![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) [![Total Lines](https://tokei.rs/b1/github/apache/Incubator-DolphinScheduler?category=lines)](https://github.com/apache/Incubator-DolphinScheduler) [![codecov](https://codecov.io/gh/apache/incubator-dolphinscheduler/branch/dev/graph/badge.svg)](https://codecov.io/gh/apache/incubator-dolphinscheduler/branch/dev) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=apache-dolphinscheduler&metric=alert_status)](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler) -> Dolphin Scheduler for Big Data - [![Stargazers over time](https://starchart.cc/apache/incubator-dolphinscheduler.svg)](https://starchart.cc/apache/incubator-dolphinscheduler) [![EN doc](https://img.shields.io/badge/document-English-blue.svg)](README.md) [![CN doc](https://img.shields.io/badge/文档-中文版-blue.svg)](README_zh_CN.md) +## Design Features -### Design features: +DolphinScheduler is a distributed and extensible workflow scheduler platform with powerful DAG visual interfaces, dedicated to solving complex job dependencies in the data pipeline and providing various types of jobs available `out of the box`. -A distributed and easy-to-extend visual DAG workflow scheduling system. Dedicated to solving the complex dependencies in data processing, making the scheduling system `out of the box` for data processing. Its main objectives are as follows: - - Associate the Tasks according to the dependencies of the tasks in a DAG graph, which can visualize the running state of task in real time. - - Support for many task types: Shell, MR, Spark, SQL (mysql, postgresql, hive, sparksql), Python, Sub_Process, Procedure, etc. - - Support process scheduling, dependency scheduling, manual scheduling, manual pause/stop/recovery, support for failed retry/alarm, recovery from specified nodes, Kill task, etc. - - Support process priority, task priority and task failover and task timeout alarm/failure - - Support process global parameters and node custom parameter settings - - Support online upload/download of resource files, management, etc. Support online file creation and editing - - Support task log online viewing and scrolling, online download log, etc. - - Implement cluster HA, decentralize Master cluster and Worker cluster through Zookeeper - - Support online viewing of `Master/Worker` cpu load, memory - - Support process running history tree/gantt chart display, support task status statistics, process status statistics - - Support backfilling data - - Support multi-tenant - - Support internationalization - - There are more waiting partners to explore - - -### What's in Dolphin Scheduler - - Stability | Easy to use | Features | Scalability | + - Associate the tasks according to the dependencies of the tasks in a DAG graph, which can visualize the running state of the task in real-time. + - Support various task types: Shell, MR, Spark, SQL (MySQL, PostgreSQL, hive, spark SQL), Python, Sub_Process, Procedure, etc. + - Support scheduling of workflows and dependencies, manual scheduling to pause/stop/recover task, support failure task retry/alarm, recover specified nodes from failure, kill task, etc. + - Support the priority of workflows & tasks, task failover, and task timeout alarm or failure. + - Support workflow global parameters and node customized parameter settings. + - Support online upload/download/management of resource files, etc. Support online file creation and editing. + - Support task log online viewing and scrolling and downloading, etc. + - Have implemented cluster HA, decentralize Master cluster and Worker cluster through Zookeeper. + - Support the viewing of Master/Worker CPU load, memory, and CPU usage metrics. + - Support displaying workflow history in tree/Gantt chart, as well as statistical analysis on the task status & process status in each workflow. + - Support back-filling data. + - Support multi-tenant. + - Support internationalization. + - More features waiting for partners to explore... + +## What's in DolphinScheduler + + Stability | Accessibility | Features | Scalability | -- | -- | -- | -- -Decentralized multi-master and multi-worker | Visualization process defines key information such as task status, task type, retry times, task running machine, visual variables and so on at a glance.  |  Support pause, recover operation | support custom task types -HA is supported by itself | All process definition operations are visualized, dragging tasks to draw DAGs, configuring data sources and resources. At the same time, for third-party systems, the api mode operation is provided. | Users on DolphinScheduler can achieve many-to-one or one-to-one mapping relationship through tenants and Hadoop users, which is very important for scheduling large data jobs. " | The scheduler uses distributed scheduling, and the overall scheduling capability will increase linearly with the scale of the cluster. Master and Worker support dynamic online and offline. -Overload processing: Task queue mechanism, the number of schedulable tasks on a single machine can be flexibly configured, when too many tasks will be cached in the task queue, will not cause machine jam. | One-click deployment | Supports traditional shell tasks, and also support big data platform task scheduling: MR, Spark, SQL (mysql, postgresql, hive, sparksql), Python, Procedure, Sub_Process | | +Decentralized multi-master and multi-worker | Visualization of workflow key information, such as task status, task type, retry times, task operation machine information, visual variables, and so on at a glance.  |  Support pause, recover operation | Support customized task types +support HA | Visualization of all workflow operations, dragging tasks to draw DAGs, configuring data sources and resources. At the same time, for third-party systems, provide API mode operations. | Users on DolphinScheduler can achieve many-to-one or one-to-one mapping relationship through tenants and Hadoop users, which is very important for scheduling large data jobs. | The scheduler supports distributed scheduling, and the overall scheduling capability will increase linearly with the scale of the cluster. Master and Worker support dynamic adjustment. +Overload processing: By using the task queue mechanism, the number of schedulable tasks on a single machine can be flexibly configured. Machine jam can be avoided with high tolerance to numbers of tasks cached in task queue. | One-click deployment | Support traditional shell tasks, and big data platform task scheduling: MR, Spark, SQL (MySQL, PostgreSQL, hive, spark SQL), Python, Procedure, Sub_Process | | - -### System partial screenshot +## User Interface Screenshots ![home page](https://user-images.githubusercontent.com/15833811/75218288-bf286400-57d4-11ea-8263-d639c6511d5f.jpg) ![dag](https://user-images.githubusercontent.com/15833811/75236750-3374fe80-57f9-11ea-857d-62a66a5a559d.png) @@ -55,19 +52,16 @@ Overload processing: Task queue mechanism, the number of schedulable tasks on a ![monitor](https://user-images.githubusercontent.com/59273635/75625839-c698a480-5bfc-11ea-8bbe-895b561b337f.png) ![security](https://user-images.githubusercontent.com/15833811/75236441-bfd2f180-57f8-11ea-88bd-f24311e01b7e.png) ![treeview](https://user-images.githubusercontent.com/15833811/75217191-3fe56100-57d1-11ea-8856-f19180d9a879.png) -### Online Demo -- Online Demo +## QuickStart in Docker -### Recent R&D plan -Work plan of Dolphin Scheduler: [R&D plan](https://github.com/apache/incubator-dolphinscheduler/projects/1), Under the `In Develop` card is what is currently being developed, TODO card is to be done (including feature ideas) +Please referer the official website document: [QuickStart in Docker](https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/docker-deployment.html) -### How to contribute +## QuickStart in Kubernetes -Welcome to participate in contributing, please refer to the process of submitting the code: -[[How to contribute](https://dolphinscheduler.apache.org/en-us/docs/development/contribute.html)] +Please referer the official website document: [QuickStart in Kubernetes](https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/kubernetes-deployment.html) -### How to Build +## How to Build ```bash ./mvnw clean install -Prelease @@ -80,17 +74,26 @@ dolphinscheduler-dist/target/apache-dolphinscheduler-incubating-${latest.release dolphinscheduler-dist/target/apache-dolphinscheduler-incubating-${latest.release.version}-src.zip: Source code package of DolphinScheduler ``` -### Thanks +## Thanks + +DolphinScheduler is based on a lot of excellent open-source projects, such as google guava, guice, grpc, netty, ali bonecp, quartz, and many open-source projects of Apache and so on. +We would like to express our deep gratitude to all the open-source projects used in Dolphin Scheduler. We hope that we are not only the beneficiaries of open-source, but also give back to the community. Besides, we hope everyone who have the same enthusiasm and passion for open source could join in and contribute to the open-source community! + +## Get Help + +1. Submit an [[issue](https://github.com/apache/incubator-dolphinscheduler/issues/new/choose)] +1. Subscribe to this mail list: https://dolphinscheduler.apache.org/en-us/community/development/subscribe.html, then email dev@dolphinscheduler.apache.org + +## Community + +You are so much welcomed to communicate with the developers and users of Dolphin Scheduler freely. There are two ways to find them: +1. Join the slack channel by [this invitation link](https://join.slack.com/t/asf-dolphinscheduler/shared_invite/zt-mzqu52gi-rCggPkSHQ0DZYkwbTxO1Gw). +2. Follow the [twitter account of Dolphin Scheduler](https://twitter.com/dolphinschedule) and get the latest news just on time. -Dolphin Scheduler uses a lot of excellent open source projects, such as google guava, guice, grpc, netty, ali bonecp, quartz, and many open source projects of apache, etc. -It is because of the shoulders of these open source projects that the birth of the Dolphin Scheduler is possible. We are very grateful for all the open source software used! We also hope that we will not only be the beneficiaries of open source, but also be open source contributors. We also hope that partners who have the same passion and conviction for open source will join in and contribute to open source! +## How to Contribute -### Get Help -1. Submit an issue -1. Subscribe the mail list : https://dolphinscheduler.apache.org/en-us/docs/development/subscribe.html. then send mail to dev@dolphinscheduler.apache.org -1. Slack channel: [![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://join.slack.com/share/zt-do3gvfhj-UUhrAX2GxkVX_~JJt1jpKA) -1. Contact WeChat(dailidong66). This is just for Mandarin(CN) discussion. +The community welcomes everyone to participate in contributing, please refer to this website to find out more: [[How to contribute](https://dolphinscheduler.apache.org/en-us/community/development/contribute.html)] -### License -Please refer to [LICENSE](https://github.com/apache/incubator-dolphinscheduler/blob/dev/LICENSE) file. +## License +Please refer to the [LICENSE](https://github.com/apache/incubator-dolphinscheduler/blob/dev/LICENSE) file. diff --git a/README_zh_CN.md b/README_zh_CN.md index a02a2c3376..abd3d378f4 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -1,23 +1,24 @@ Dolphin Scheduler Official Website [dolphinscheduler.apache.org](https://dolphinscheduler.apache.org) ============ + [![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) [![Total Lines](https://tokei.rs/b1/github/apache/Incubator-DolphinScheduler?category=lines)](https://github.com/apache/Incubator-DolphinScheduler) [![codecov](https://codecov.io/gh/apache/incubator-dolphinscheduler/branch/dev/graph/badge.svg)](https://codecov.io/gh/apache/incubator-dolphinscheduler/branch/dev) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=apache-dolphinscheduler&metric=alert_status)](https://sonarcloud.io/dashboard?id=apache-dolphinscheduler) -> Dolphin Scheduler for Big Data - - [![Stargazers over time](https://starchart.cc/apache/incubator-dolphinscheduler.svg)](https://starchart.cc/apache/incubator-dolphinscheduler) [![CN doc](https://img.shields.io/badge/文档-中文版-blue.svg)](README_zh_CN.md) [![EN doc](https://img.shields.io/badge/document-English-blue.svg)](README.md) +## 设计特点 + +一个分布式易扩展的可视化DAG工作流任务调度系统。致力于解决数据处理流程中错综复杂的依赖关系，使调度系统在数据处理流程中`开箱即用`。 -**设计特点：** 一个分布式易扩展的可视化DAG工作流任务调度系统。致力于解决数据处理流程中错综复杂的依赖关系，使调度系统在数据处理流程中`开箱即用`。 其主要目标如下： + - 以DAG图的方式将Task按照任务的依赖关系关联起来，可实时可视化监控任务的运行状态 - 支持丰富的任务类型：Shell、MR、Spark、SQL(mysql、postgresql、hive、sparksql),Python,Sub_Process、Procedure等 - 支持工作流定时调度、依赖调度、手动调度、手动暂停/停止/恢复，同时支持失败重试/告警、从指定节点恢复失败、Kill任务等操作 @@ -33,8 +34,7 @@ Dolphin Scheduler Official Website - 支持国际化 - 还有更多等待伙伴们探索 - -### 系统部分截图 +## 系统部分截图 ![home page](https://user-images.githubusercontent.com/15833811/75208819-abbad000-57b7-11ea-8d3c-67e7c270671f.jpg) @@ -50,51 +50,51 @@ Dolphin Scheduler Official Website ![security](https://user-images.githubusercontent.com/15833811/75209633-baa28200-57b9-11ea-9def-94bef2e212a7.jpg) -### 我要体验 +## 近期研发计划 -- 我要体验 +DolphinScheduler的工作计划：研发计划 ，其中 In Develop卡片下是正在研发的功能，TODO卡片是待做事项(包括 feature ideas) +## 参与贡献 -### 近期研发计划 +非常欢迎大家来参与贡献，贡献流程请参考： +[[参与贡献](https://dolphinscheduler.apache.org/zh-cn/community/development/contribute.html)] -DolphinScheduler的工作计划：研发计划 ，其中 In Develop卡片下是正在研发的功能，TODO卡片是待做事项(包括 feature ideas) +## 快速试用 Docker -### 参与贡献 +请参考官方文档: [快速试用 Docker 部署](https://dolphinscheduler.apache.org/zh-cn/docs/latest/user_doc/docker-deployment.html) -非常欢迎大家来参与贡献，贡献流程请参考： -[[参与贡献](https://dolphinscheduler.apache.org/zh-cn/docs/development/contribute.html)] +## 快速试用 Kubernetes + +请参考官方文档: [快速试用 Kubernetes 部署](https://dolphinscheduler.apache.org/zh-cn/docs/latest/user_doc/kubernetes-deployment.html) -### How to Build +## 如何构建 ```bash ./mvnw clean install -Prelease ``` -Artifact: +制品: ``` -dolphinscheduler-dist/target/apache-dolphinscheduler-incubating-${latest.release.version}-dolphinscheduler-bin.tar.gz: Binary package of DolphinScheduler -dolphinscheduler-dist/target/apache-dolphinscheduler-incubating-${latest.release.version}-src.zip: Source code package of DolphinScheduler +dolphinscheduler-dist/target/apache-dolphinscheduler-incubating-${latest.release.version}-dolphinscheduler-bin.tar.gz: DolphinScheduler 二进制包 +dolphinscheduler-dist/target/apache-dolphinscheduler-incubating-${latest.release.version}-src.zip: DolphinScheduler 源代码包 ``` -### 感谢 +## 感谢 Dolphin Scheduler使用了很多优秀的开源项目，比如google的guava、guice、grpc，netty，ali的bonecp，quartz，以及apache的众多开源项目等等， 正是由于站在这些开源项目的肩膀上，才有Dolphin Scheduler的诞生的可能。对此我们对使用的所有开源软件表示非常的感谢！我们也希望自己不仅是开源的受益者，也能成为开源的贡献者,也希望对开源有同样热情和信念的伙伴加入进来，一起为开源献出一份力！ +## 获得帮助 -### 获得帮助 1. 提交issue -1. 先订阅邮件开发列表:[订阅邮件列表](https://dolphinscheduler.apache.org/zh-cn/docs/development/subscribe.html), 订阅成功后发送邮件到dev@dolphinscheduler.apache.org. -1. 联系微信群助手(ID:dailidong66). 微信仅用于中国用户讨论. - -### 版权 -请参考 [LICENSE](https://github.com/apache/incubator-dolphinscheduler/blob/dev/LICENSE) 文件. - - - - +2. 先订阅邮件开发列表:[订阅邮件列表](https://dolphinscheduler.apache.org/zh-cn/community/development/subscribe.html), 订阅成功后发送邮件到dev@dolphinscheduler.apache.org. +## 社区 +1. 通过[该申请链接](https://join.slack.com/t/asf-dolphinscheduler/shared_invite/zt-mzqu52gi-rCggPkSHQ0DZYkwbTxO1Gw)加入slack channel +2. 关注[Apache Dolphin Scheduler的Twitter账号](https://twitter.com/dolphinschedule)获取实时动态 +## 版权 +请参考 [LICENSE](https://github.com/apache/incubator-dolphinscheduler/blob/dev/LICENSE) 文件.