From 8b50578bdb205ed15a43057d4da62bd372ff3fc6 Mon Sep 17 00:00:00 2001 From: xuhhui Date: Tue, 26 Jul 2022 18:08:19 +0800 Subject: [PATCH] [doc] Fix bugs in doc installation, design and glossary (#11084) --- docs/docs/en/architecture/design.md | 2 +- docs/docs/en/guide/installation/cluster.md | 2 +- docs/docs/en/guide/installation/pseudo-cluster.md | 8 ++++---- docs/docs/zh/about/glossary.md | 2 +- docs/docs/zh/architecture/design.md | 2 +- docs/docs/zh/guide/installation/cluster.md | 2 +- docs/docs/zh/guide/installation/pseudo-cluster.md | 8 ++++---- docs/docs/zh/guide/project/workflow-definition.md | 2 +- 8 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/docs/en/architecture/design.md b/docs/docs/en/architecture/design.md index 24776101fd..9e09e15948 100644 --- a/docs/docs/en/architecture/design.md +++ b/docs/docs/en/architecture/design.md @@ -49,7 +49,7 @@ WorkerServer also adopts a distributed and decentralized design concept. WorkerServer is mainly responsible for task execution and providing log services. When the WorkerServer service starts, register a temporary node with ZooKeeper and maintain a heartbeat. - Server provides monitoring services based on netty. + WorkerServer provides monitoring services based on netty. #### The Service Mainly Includes: diff --git a/docs/docs/en/guide/installation/cluster.md b/docs/docs/en/guide/installation/cluster.md index 37032b85a0..d7054ac721 100644 --- a/docs/docs/en/guide/installation/cluster.md +++ b/docs/docs/en/guide/installation/cluster.md @@ -14,7 +14,7 @@ Configure all the configurations refer to [pseudo-cluster deployment](pseudo-clu ### Modify Configuration -This step differs quite a lot from [pseudo-cluster deployment](pseudo-cluster.md), because the deployment script transfers the required resources for installation to each deployment machine by using `scp`. So we only need to modify the configuration of the machine that runs `install.sh` script and configurations will dispatch to cluster by `scp`. The configuration file is under the path `conf/config/install_config.conf`, here we only need to modify section **INSTALL MACHINE**, **DolphinScheduler ENV, Database, Registry Server** and keep other sections the same as [pseudo-cluster deployment](pseudo-cluster .md), the following describes the parameters that must be modified: +This step differs quite a lot from [pseudo-cluster deployment](pseudo-cluster.md), because the deployment script transfers the required resources for installation to each deployment machine by using `scp`. So we only need to modify the configuration of the machine that runs `install.sh` script and configurations will dispatch to cluster by `scp`. The configuration file is under the path `bin/env/install_env.sh`, here we only need to modify section **INSTALL MACHINE**, **DolphinScheduler ENV, Database, Registry Server** and keep other sections the same as [pseudo-cluster deployment](pseudo-cluster .md), the following describes the parameters that must be modified: ```shell # --------------------------------------------------------- diff --git a/docs/docs/en/guide/installation/pseudo-cluster.md b/docs/docs/en/guide/installation/pseudo-cluster.md index 0190c78f06..22a5af0afa 100644 --- a/docs/docs/en/guide/installation/pseudo-cluster.md +++ b/docs/docs/en/guide/installation/pseudo-cluster.md @@ -185,10 +185,10 @@ bash ./bin/dolphinscheduler-daemon.sh start alert-server bash ./bin/dolphinscheduler-daemon.sh stop alert-server ``` -> **_Note1:_**: Each server have `dolphinscheduler_env.sh` file in path `/conf/dolphinscheduler_env.sh` which -> for micro-services need. It means that you could start all servers by command `/bin/start.sh` with different -> environment variable from `bin/env/dolphinscheduler_env.sh`. But it will use file `bin/env/dolphinscheduler_env.sh` overwrite -> `/conf/dolphinscheduler_env.sh` if you start server with command `/bin/dolphinscheduler-daemon.sh start `. +> **_Note1:_**: Each server have `dolphinscheduler_env.sh` file in path `/conf/dolphinscheduler_env.sh` which +> for micro-services need. It means that you could start all servers by command `/bin/start.sh` with different +> environment variable from `/conf/dolphinscheduler_env.sh`. But it will use file `bin/env/dolphinscheduler_env.sh` overwrite +> `/conf/dolphinscheduler_env.sh` if you start server with command `/bin/dolphinscheduler-daemon.sh start `. > **_Note2:_**: Please refer to the section of "System Architecture Design" for service usage. Python gateway service is > started along with the api-server, and if you do not want to start Python gateway service please disabled it by changing diff --git a/docs/docs/zh/about/glossary.md b/docs/docs/zh/about/glossary.md index dd3043cc29..2b9f967661 100644 --- a/docs/docs/zh/about/glossary.md +++ b/docs/docs/zh/about/glossary.md @@ -10,7 +10,7 @@ **流程定义**：通过拖拽任务节点并建立任务节点的关联所形成的可视化**DAG** -**流程实例**：流程实例是流程定义的实例化，可以通过手动启动或定时调度生成,流程定义每运行一次，产生一个流程实例 +**流程实例**：流程实例是流程定义的实例化，可以通过手动启动或定时调度生成，流程定义每运行一次，产生一个流程实例 **任务实例**：任务实例是流程定义中任务节点的实例化，标识着具体的任务执行状态 diff --git a/docs/docs/zh/architecture/design.md b/docs/docs/zh/architecture/design.md index 6e8a6f35fc..c8910e642a 100644 --- a/docs/docs/zh/architecture/design.md +++ b/docs/docs/zh/architecture/design.md @@ -46,7 +46,7 @@ WorkerServer也采用分布式无中心设计理念，WorkerServer主要负责任务的执行和提供日志服务。 WorkerServer服务启动时向Zookeeper注册临时节点，并维持心跳。 - Server基于netty提供监听服务。 + WorkerServer基于netty提供监听服务。 ##### 该服务包含： - **WorkerManagerThread**主要负责任务队列的提交，不断从任务队列中领取任务，提交到线程池处理； diff --git a/docs/docs/zh/guide/installation/cluster.md b/docs/docs/zh/guide/installation/cluster.md index 194a411ca0..97c1792787 100644 --- a/docs/docs/zh/guide/installation/cluster.md +++ b/docs/docs/zh/guide/installation/cluster.md @@ -14,7 +14,7 @@ ### 修改相关配置 -这个是与[伪集群部署](pseudo-cluster.md)差异较大的一步，因为部署脚本会通过 `scp` 的方式将安装需要的资源传输到各个机器上，所以这一步我们仅需要修改运行`install.sh`脚本的所在机器的配置即可。配置文件在路径在`conf/config/install_config.conf`下，此处我们仅需修改**INSTALL MACHINE**，**DolphinScheduler ENV、Database、Registry Server**与伪集群部署保持一致，下面对必须修改参数进行说明 +这个是与[伪集群部署](pseudo-cluster.md)差异较大的一步，因为部署脚本会通过 `scp` 的方式将安装需要的资源传输到各个机器上，所以这一步我们仅需要修改运行`install.sh`脚本的所在机器的配置即可。配置文件在路径在`bin/env/install_env.sh`下，此处我们仅需修改**INSTALL MACHINE**，**DolphinScheduler ENV、Database、Registry Server**与伪集群部署保持一致，下面对必须修改参数进行说明 ```shell # --------------------------------------------------------- diff --git a/docs/docs/zh/guide/installation/pseudo-cluster.md b/docs/docs/zh/guide/installation/pseudo-cluster.md index 54ac904a01..9e9626a511 100644 --- a/docs/docs/zh/guide/installation/pseudo-cluster.md +++ b/docs/docs/zh/guide/installation/pseudo-cluster.md @@ -181,10 +181,10 @@ bash ./bin/dolphinscheduler-daemon.sh start alert-server bash ./bin/dolphinscheduler-daemon.sh stop alert-server ``` -> **_注意1:_**: 每个服务在路径 `/conf/dolphinscheduler_env.sh` 中都有 `dolphinscheduler_env.sh` 文件，这是可以为微 -> 服务需求提供便利。意味着您可以基于不同的环境变量来启动各个服务，只需要在对应服务中配置 `bin/env/dolphinscheduler_env.sh` 然后通过 `/bin/start.sh` -> 命令启动即可。但是如果您使用命令 `/bin/dolphinscheduler-daemon.sh start ` 启动服务器，它将会用文件 `bin/env/dolphinscheduler_env.sh` -> 覆盖 `/conf/dolphinscheduler_env.sh` 然后启动服务，目的是为了减少用户修改配置的成本. +> **_注意1:_**: 每个服务在路径 `/conf/dolphinscheduler_env.sh` 中都有 `dolphinscheduler_env.sh` 文件，这是可以为微 +> 服务需求提供便利。意味着您可以基于不同的环境变量来启动各个服务，只需要在对应服务中配置 `/conf/dolphinscheduler_env.sh` 然后通过 `/bin/start.sh` +> 命令启动即可。但是如果您使用命令 `/bin/dolphinscheduler-daemon.sh start ` 启动服务器，它将会用文件 `bin/env/dolphinscheduler_env.sh` +> 覆盖 `/conf/dolphinscheduler_env.sh` 然后启动服务，目的是为了减少用户修改配置的成本. > **_注意2:_**：服务用途请具体参见《系统架构设计》小节。Python gateway service 默认与 api-server 一起启动，如果您不想启动 Python gateway service > 请通过更改 api-server 配置文件 `api-server/conf/application.yaml` 中的 `python-gateway.enabled : false` 来禁用它。 diff --git a/docs/docs/zh/guide/project/workflow-definition.md b/docs/docs/zh/guide/project/workflow-definition.md index ceb11f4122..5d110b6554 100644 --- a/docs/docs/zh/guide/project/workflow-definition.md +++ b/docs/docs/zh/guide/project/workflow-definition.md @@ -16,7 +16,7 @@ 1. “运行标志”勾选“正常”，若勾选“禁止执行”，运行工作流不会执行该任务； 1. 选择“任务优先级”：当 worker 线程数不足时，级别高的任务在执行队列中会优先执行，相同优先级的任务按照先进先出的顺序执行； 1. 超时告警（非必选）：勾选超时告警、超时失败，填写“超时时长”，当任务执行时间超过**超时时长**，会发送告警邮件并且任务超时失败； - 1. 资源（非必选）。资源文件是资源中心->文件管理页面创建或上传的文件，如文件名为 `test.sh`，脚本中调用资源命令为 `sh test.sh`； + 1. 资源（非必选）：资源文件是资源中心->文件管理页面创建或上传的文件，如文件名为 `test.sh`，脚本中调用资源命令为 `sh test.sh`； 1. 自定义参数（非必填）； 1. 点击"确认添加"按钮，保存任务设置。