Browse Source

[doc] Fix bugs in doc installation, design and glossary (#11084)

xuhhui 2 years ago
parent
commit
8b50578bdb

+ 1 - 1
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:
 

File diff suppressed because it is too large
+ 1 - 1
docs/docs/en/guide/installation/cluster.md


+ 4 - 4
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 `<server-name>/conf/dolphinscheduler_env.sh` which
-> for micro-services need. It means that you could start all servers by command `<server-name>/bin/start.sh` with different
-> environment variable from `bin/env/dolphinscheduler_env.sh`. But it will use file `bin/env/dolphinscheduler_env.sh` overwrite
-> `<server-name>/conf/dolphinscheduler_env.sh` if you start server with command `/bin/dolphinscheduler-daemon.sh start <server-name>`.
+> **_Note1:_**: Each server have `dolphinscheduler_env.sh` file in path `<service>/conf/dolphinscheduler_env.sh` which
+> for micro-services need. It means that you could start all servers by command `<service>/bin/start.sh` with different
+> environment variable from `<service>/conf/dolphinscheduler_env.sh`. But it will use file `bin/env/dolphinscheduler_env.sh` overwrite
+> `<service>/conf/dolphinscheduler_env.sh` if you start server with command `/bin/dolphinscheduler-daemon.sh start <service>`.
 
 > **_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

+ 1 - 1
docs/docs/zh/about/glossary.md

@@ -10,7 +10,7 @@
 
 **流程定义**:通过拖拽任务节点并建立任务节点的关联所形成的可视化**DAG**
 
-**流程实例**:流程实例是流程定义的实例化,可以通过手动启动或定时调度生成,流程定义每运行一次,产生一个流程实例
+**流程实例**:流程实例是流程定义的实例化,可以通过手动启动或定时调度生成流程定义每运行一次,产生一个流程实例
 
 **任务实例**:任务实例是流程定义中任务节点的实例化,标识着具体的任务执行状态
 

+ 1 - 1
docs/docs/zh/architecture/design.md

@@ -46,7 +46,7 @@
 
      WorkerServer也采用分布式无中心设计理念,WorkerServer主要负责任务的执行和提供日志服务。
      WorkerServer服务启动时向Zookeeper注册临时节点,并维持心跳。
-     Server基于netty提供监听服务。
+     WorkerServer基于netty提供监听服务。
      ##### 该服务包含:
 
      - **WorkerManagerThread**主要负责任务队列的提交,不断从任务队列中领取任务,提交到线程池处理;

+ 1 - 1
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
 # ---------------------------------------------------------

+ 4 - 4
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:_**: 每个服务在路径 `<server-name>/conf/dolphinscheduler_env.sh` 中都有 `dolphinscheduler_env.sh` 文件,这是可以为微
-> 服务需求提供便利。意味着您可以基于不同的环境变量来启动各个服务,只需要在对应服务中配置 `bin/env/dolphinscheduler_env.sh` 然后通过 `<server-name>/bin/start.sh`
-> 命令启动即可。但是如果您使用命令 `/bin/dolphinscheduler-daemon.sh start <server-name>` 启动服务器,它将会用文件 `bin/env/dolphinscheduler_env.sh`
-> 覆盖 `<server-name>/conf/dolphinscheduler_env.sh` 然后启动服务,目的是为了减少用户修改配置的成本.
+> **_注意1:_**: 每个服务在路径 `<service>/conf/dolphinscheduler_env.sh` 中都有 `dolphinscheduler_env.sh` 文件,这是可以为微
+> 服务需求提供便利。意味着您可以基于不同的环境变量来启动各个服务,只需要在对应服务中配置 `<service>/conf/dolphinscheduler_env.sh` 然后通过 `<service>/bin/start.sh`
+> 命令启动即可。但是如果您使用命令 `/bin/dolphinscheduler-daemon.sh start <service>` 启动服务器,它将会用文件 `bin/env/dolphinscheduler_env.sh`
+> 覆盖 `<service>/conf/dolphinscheduler_env.sh` 然后启动服务,目的是为了减少用户修改配置的成本.
 
 > **_注意2:_**:服务用途请具体参见《系统架构设计》小节。Python gateway service 默认与 api-server 一起启动,如果您不想启动 Python gateway service
 > 请通过更改 api-server 配置文件 `api-server/conf/application.yaml` 中的 `python-gateway.enabled : false` 来禁用它。

+ 1 - 1
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. 点击"确认添加"按钮,保存任务设置。