Skip to content

Commit dcf02ea

Browse files
authored
[Fix] Replaced dead links in the docs. (#13170)
* [Fix] Replaced dead links. * [Improvement] Format markdowns.
1 parent ab96a3d commit dcf02ea

25 files changed

Lines changed: 422 additions & 418 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,38 +12,39 @@ Dolphin Scheduler Official Website
1212

1313
[![EN doc](https://img.shields.io/badge/document-English-blue.svg)](README.md)
1414

15-
1615
## Features
1716

1817
Apache DolphinScheduler is the modern data workflow orchestration platform with powerful user interface, dedicated to solving complex task dependencies in the data pipeline and providing various types of jobs available `out of the box`
1918

2019
The key features for DolphinScheduler are as follows:
20+
2121
- Easy to deploy, we provide 4 ways to deploy, such as Standalone deployment,Cluster deployment,Docker / Kubernetes deployment and Rainbond deployment
2222
- Easy to use, there are four ways to create workflows:
23+
2324
- Visually, create tasks by dragging and dropping tasks
2425
- [PyDolphinScheduler](https://dolphinscheduler.apache.org/python/main/index.html), Creating workflows via Python API, aka workflow-as-code
2526
- Yaml definition, mapping yaml into workflow(have to install PyDolphinScheduler currently)
2627
- Open API, Creating workflows
2728

2829
- Highly Reliable,
29-
DolphinScheduler uses a decentralized multi-master and multi-worker architecture, which naturally supports horizontal scaling and high availability
30+
DolphinScheduler uses a decentralized multi-master and multi-worker architecture, which naturally supports horizontal scaling and high availability
3031
- High performance, its performance is N times faster than other orchestration platform and it can support tens of millions of tasks per day
3132
- Supports multi-tenancy
3233
- Supports various task types: Shell, MR, Spark, SQL (MySQL, PostgreSQL, Hive, Spark SQL), Python, Procedure, Sub_Workflow,
33-
Http, K8s, Jupyter, MLflow, SageMaker, DVC, Pytorch, Amazon EMR, etc
34+
Http, K8s, Jupyter, MLflow, SageMaker, DVC, Pytorch, Amazon EMR, etc
3435
- Orchestrating workflows and dependencies, you can pause/stop/recover task any time, failed tasks can be set to automatically retry
3536
- Visualizing the running state of the task in real-time and seeing the task runtime log
3637
- What you see is what you get when you edit the task on the UI
3738
- Backfill can be operated on the UI directly
3839
- Perfect project, resource, data source-level permission control
3940
- Displaying workflow history in tree/Gantt chart, as well as statistical analysis on the task status & process status in each workflow
4041
- Supports internationalization
41-
- Cloud Native, DolphinScheduler supports orchestrating multi-cloud/data center workflow, and
42-
supports custom task type
42+
- Cloud Native, DolphinScheduler supports orchestrating multi-cloud/data center workflow, and
43+
supports custom task type
4344
- More features waiting for partners to explore
4445

45-
4646
## User Interface Screenshots
47+
4748
![dag](./images/en_US/dag.png)
4849
<img width="1100" src="https://user-images.githubusercontent.com/15833811/197348110-1653ea32-ce07-436c-a0b8-6ac1af80aea5.png">
4950
![data-source](./images/en_US/data-source.png)
@@ -53,11 +54,11 @@ supports custom task type
5354

5455
## QuickStart in Docker
5556

56-
Please refer the official website document: [QuickStart in Docker](https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/guide/start/docker.html)
57+
Please refer the official website document: [QuickStart in Docker](https://dolphinscheduler.apache.org/#/en-us/docs/3.1.2/guide/start/docker)
5758

5859
## QuickStart in Kubernetes
5960

60-
Please refer to the official website document: [QuickStart in Kubernetes](https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/guide/installation/kubernetes.html)
61+
Please refer to the official website document: [QuickStart in Kubernetes](https://dolphinscheduler.apache.org/#/en-us/docs/3.1.2/guide/installation/kubernetes)
6162

6263
## How to Build
6364

@@ -81,14 +82,14 @@ dolphinscheduler-dist/target/apache-dolphinscheduler-${latest.release.version}-s
8182
## Community
8283

8384
You are very welcome to communicate with the developers and users of Dolphin Scheduler. There are two ways to find them:
85+
8486
1. Join the Slack channel [Slack](https://asf-dolphinscheduler.slack.com/)
8587
2. Follow the [Twitter account of DolphinScheduler](https://twitter.com/dolphinschedule) and get the latest news on time
8688

8789
## How to Contribute
8890

8991
The community welcomes everyone to contribute, please refer to this page to find out more: [How to contribute](docs/docs/en/contribute/join/contribute.md).
9092

91-
9293
## Thanks
9394

9495
DolphinScheduler is based on a lot of excellent open-source projects, such as Google guava, grpc, netty, quartz, and many open-source projects of Apache and so on.

‎README_zh_CN.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,19 @@ Dolphin Scheduler Official Website
1313

1414
## 设计特点
1515

16-
一个分布式易扩展的可视化DAG工作流任务调度系统。致力于解决数据处理流程中错综复杂的依赖关系,使调度系统在数据处理流程中`开箱即用`
16+
一个分布式易扩展的可视化 DAG 工作流任务调度系统。致力于解决数据处理流程中错综复杂的依赖关系,使调度系统在数据处理流程中`开箱即用`
1717

1818
其主要目标如下:
1919

20-
- 以DAG图的方式将Task按照任务的依赖关系关联起来,可实时可视化监控任务的运行状态
21-
- 支持丰富的任务类型:Shell、MR、Spark、SQL(mysql、postgresql、hive、sparksql)、Python、Sub_Process、Procedure等
22-
- 支持工作流定时调度、依赖调度、手动调度、手动暂停/停止/恢复,同时支持失败重���/告警、从指定节点恢复失败、Kill任务等操作
20+
- 以 DAG 图的方式将 Task 按照任务的依赖关系关联起来,可实时可视化监控任务的运行状态
21+
- 支持丰富的任务类型:Shell、MR、Spark、SQL(mysql、postgresql、hive、sparksql)、Python、Sub_Process、Procedure 等
22+
- 支持工作流定时调度、依赖调度、手动调度、手动暂停/停止/恢复,同时支持失败重试/告警、从指定节点恢复失败、Kill 任务等操作
2323
- 支持工作流优先级、任务优先级及任务的故障转移及任务超时告警/失败
2424
- 支持工作流全局参数及节点自定义参数设置
2525
- 支持资源文件的在线上传/下载,管理等,支持在线文件创建、编辑
2626
- 支持任务日志在线查看及滚动、在线下载日志等
27-
- 实现集群HA,通过Zookeeper实现Master集群和Worker集群去中心化
28-
- 支持对`Master/Worker` cpu load,memory,cpu在线查看
27+
- 实现集群 HA,通过 Zookeeper 实现 Master 集群和 Worker 集群去中心化
28+
- 支持对`Master/Worker` cpu load,memory,cpu 在线查看
2929
- 支持工作流运行历史树形/甘特图展示、支持任务状态统计、流程状态统计
3030
- 支持补数
3131
- 支持多租户
@@ -42,7 +42,7 @@ Dolphin Scheduler Official Website
4242

4343
## 近期研发计划
4444

45-
DolphinScheduler的工作计划:<a href="https://github.com/apache/dolphinscheduler/projects/1" target="_blank">研发计划</a> ,其中 In Develop卡片下是正在研发的功能,TODO卡片是待做事项(包括 feature ideas)
45+
DolphinScheduler 的工作计划:<a href="https://github.com/apache/dolphinscheduler/projects/1" target="_blank">研发计划</a> ,其中 In Develop 卡片下是正在研发的功能,TODO 卡片是待做事项(包括 feature ideas)
4646

4747
## 参与贡献
4848

@@ -51,11 +51,11 @@ DolphinScheduler的工作计划:<a href="https://github.com/apache/dolphinsche
5151

5252
## 快速试用 Docker
5353

54-
请参考官方文档: [快速试用 Docker 部署](https://dolphinscheduler.apache.org/zh-cn/docs/latest/user_doc/guide/start/docker.html)
54+
请参考官方文档: [快速试用 Docker 部署](https://dolphinscheduler.apache.org/#/zh-cn/docs/3.1.2/guide/start/docker)
5555

5656
## 快速试用 Kubernetes
5757

58-
请参考官方文档: [快速试用 Kubernetes 部署](http://dolphinscheduler.apache.org/zh-cn/docs/latest/user_doc/guide/installation/kubernetes.html)
58+
请参考官方文档: [快速试用 Kubernetes 部署](http://dolphinscheduler.apache.org/#/zh-cn/docs/3.1.2/guide/installation/kubernetes)
5959

6060
## 如何构建
6161

@@ -72,18 +72,18 @@ dolphinscheduler-dist/target/apache-dolphinscheduler-${latest.release.version}-s
7272

7373
## 感谢
7474

75-
Dolphin Scheduler使用了很多优秀的开源项目,比如google的guava、grpc,netty,quartz,以及apache的众多开源项目等等
76-
正是由于站在这些开源项目的肩膀上,才有Dolphin Scheduler的诞生的可能。对此我们对使用的所有开源软件表示非常的感谢!我们也希望自己不仅是开源的受益者,也能成为开源的贡献者,也希望对开源有同样热情和信念的伙伴加入进来,一起为开源献出一份力!
75+
Dolphin Scheduler 使用了很多优秀的开源项目,比如 google 的 guava、grpc,netty,quartz,以及 apache 的众多开源项目等等
76+
正是由于站在这些开源项目的肩膀上,才有 Dolphin Scheduler 的诞生的可能。对此我们对使用的所有开源软件表示非常的感谢!我们也希望自己不仅是开源的受益者,也能成为开源的贡献者,也希望对开源有同样热情和信念的伙伴加入进来,一起为开源献出一份力!
7777

7878
## 获得帮助
7979

8080
1. 提交 [issue](https://github.com/apache/dolphinscheduler/issues/new/choose)
81-
2. [加入slack群](https://s.apache.org/dolphinscheduler-slack) 并在频道 `#troubleshooting` 中提问
81+
2. [加入 slack 群](https://s.apache.org/dolphinscheduler-slack) 并在频道 `#troubleshooting` 中提问
8282

8383
## 社区
8484

85-
1. 通过[该申请链接](https://s.apache.org/dolphinscheduler-slack)加入slack channel
86-
2. 关注[Apache Dolphin Scheduler的Twitter账号](https://twitter.com/dolphinschedule)获取实时动态
85+
1. 通过[该申请链接](https://s.apache.org/dolphinscheduler-slack)加入 slack channel
86+
2. 关注[Apache Dolphin Scheduler 的 Twitter 账号](https://twitter.com/dolphinschedule)获取实时动态
8787

8888
## 版权
8989

‎deploy/README.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# DolphinScheduler for Docker and Kubernetes
22

3-
* [Start Up DolphinScheduler with Docker](https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/guide/start/docker.html)
4-
* [Start Up DolphinScheduler with Kubernetes](https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/guide/installation/kubernetes.html)
5-
3+
- [Start Up DolphinScheduler with Docker](https://dolphinscheduler.apache.org/#/en-us/docs/3.1.2/guide/start/docker)
4+
- [Start Up DolphinScheduler with Kubernetes](https://dolphinscheduler.apache.org/#/en-us/docs/3.1.2/guide/installation/kubernetes)

‎docs/docs/en/contribute/architecture-design.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ Before explaining the architecture of the schedule system, let us first understa
1515

1616
**Process definition**: Visualization **DAG** by dragging task nodes and establishing associations of task nodes
1717

18-
**Process instance**: A process instance is an instantiation of a process definition, which can be generated by manual startup or scheduling. The process definition runs once, a new process instance is generated
18+
**Process instance**: A process instance is an instantiation of a process definition, which can be generated by manual startup or scheduling. The process definition runs once, a new process instance is generated
1919

2020
**Task instance**: A task instance is the instantiation of a specific task node when a process instance runs, which indicates the specific task execution status
2121

2222
**Task type**: Currently supports SHELL, SQL, SUB_PROCESS (sub-process), PROCEDURE, MR, SPARK, PYTHON, DEPENDENT (dependency), and plans to support dynamic plug-in extension, note: the sub-**SUB_PROCESS** is also A separate process definition that can be launched separately
2323

24-
**Schedule mode** : The system supports timing schedule and manual schedule based on cron expressions. Command type support: start workflow, start execution from current node, resume fault-tolerant workflow, resume pause process, start execution from failed node, complement, timer, rerun, pause, stop, resume waiting thread. Where **recovers the fault-tolerant workflow** and **restores the waiting thread** The two command types are used by the scheduling internal control and cannot be called externally
24+
**Schedule mode** : The system supports timing schedule and manual schedule based on cron expressions. Command type support: start workflow, start execution from current node, resume fault-tolerant workflow, resume pause process, start execution from failed node, complement, timer, rerun, pause, stop, resume waiting thread. Where **recovers the fault-tolerant workflow** and **restores the waiting thread** The two command types are used by the scheduling internal control and cannot be called externally
2525

2626
**Timed schedule**: The system uses **quartz** distributed scheduler and supports the generation of cron expression visualization
2727

@@ -48,7 +48,7 @@ Before explaining the architecture of the schedule system, let us first understa
4848

4949
#### 2.2 Architectural description
5050

51-
* **MasterServer**
51+
- **MasterServer**
5252

5353
MasterServer adopts the distributed non-central design concept. MasterServer is mainly responsible for DAG task split, task submission monitoring, and monitoring the health status of other MasterServer and WorkerServer.
5454
When the MasterServer service starts, it registers a temporary node with Zookeeper, and listens to the Zookeeper temporary node state change for fault tolerance processing.
@@ -63,7 +63,7 @@ Before explaining the architecture of the schedule system, let us first understa
6363

6464
- **MasterTaskExecThread** is mainly responsible for task persistence
6565

66-
* **WorkerServer**
66+
- **WorkerServer**
6767

6868
- WorkerServer also adopts a distributed, non-central design concept. WorkerServer is mainly responsible for task execution and providing log services. When the WorkerServer service starts, it registers the temporary node with Zookeeper and maintains the heartbeat.
6969

@@ -90,7 +90,7 @@ Before explaining the architecture of the schedule system, let us first understa
9090

9191
- **UI**
9292

93-
The front-end page of the system provides various visual operation interfaces of the system. For details, see the [quick start](https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/about/introduction.html) section.
93+
The front-end page of the system provides various visual operation interfaces of the system. For details, see the [quick start](https://dolphinscheduler.apache.org/#/en-us/docs/3.1.2/about/introduction) section.
9494

9595
#### 2.3 Architectural Design Ideas
9696

@@ -246,7 +246,7 @@ In the early scheduling design, if there is no priority design and fair scheduli
246246
* task log appender
247247
*/
248248
Public class TaskLogAppender extends FileAppender<ILoggingEvent> {
249-
249+
250250
...
251251

252252
@Override

0 commit comments

Comments
 (0)