Skip to content

Commit 17c5359

Browse files
committed
Optimize deployment doc and delete unnecessary appconn doc
1 parent eccb232 commit 17c5359

13 files changed

+37
-274
lines changed
Binary file not shown.
-106 KB
Binary file not shown.
Binary file not shown.
-148 KB
Binary file not shown.
Binary file not shown.

zh_CN/安装部署/DSS&Linkis一键部署文档单机版.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,7 @@ HIVE_PASSWORD=xxx
394394
| Schedulis | Schedulis0.7.0 | [Schedulis部署](https://github.com/WeBankFinTech/Schedulis/blob/master/docs/schedulis_deploy_cn.md) | [Schedulis AppConn部署](SchedulisAppConn插件安装文档.md)|
395395
| Visualis | Visualis1.0.0 | [Visualis部署](https://github.com/WeBankFinTech/Visualis/blob/master/visualis_docs/zh_CN/Visualis_deploy_doc_cn.md) |[Visualis AppConn部署](https://github.com/WeBankFinTech/Visualis/blob/master/visualis_docs/zh_CN/Visualis_appconn_install_cn.md)|
396396
| Exchangis | Exchangis1.0.0 | [Exchangis部署](https://github.com/WeDataSphere/Exchangis/blob/master/docs/zh_CN/ch1/exchangis_deploy_cn.md) | [Exchangis AppConn部署](https://github.com/WeDataSphere/Exchangis/blob/master/docs/zh_CN/ch1/exchangis_appconn_deploy_cn.md) |
397-
| Qualitis |Qualitis0.9.2 | [Qualitis部署](https://github.com/WeBankFinTech/Qualitis/blob/master/docs/zh_CN/ch1/%E5%BF%AB%E9%80%9F%E6%90%AD%E5%BB%BA%E6%89%8B%E5%86%8C%E2%80%94%E2%80%94%E5%8D%95%E6%9C%BA%E7%89%88.md) |[Qualitis AppConn部署](https://github.com/WeBankFinTech/Qualitis/blob/master/docs/zh_CN/ch1/%E6%8E%A5%E5%85%A5%E5%B7%A5%E4%BD%9C%E6%B5%81%E6%8C%87%E5%8D%97.md) |
398-
| Prophecis | Prophecis0.3.2 | [Prophecis部署]() | [Prophecis AppConn部署]() |
399-
| Streamis | Streamis0.2.0 | [Streamis部署]() | [Streamis AppConn部署]() |
397+
| Qualitis |Qualitis0.9.2 | [Qualitis部署](https://github.com/WeBankFinTech/Qualitis/blob/master/docs/zh_CN/ch1/%E5%BF%AB%E9%80%9F%E6%90%AD%E5%BB%BA%E6%89%8B%E5%86%8C%E2%80%94%E2%80%94%E5%8D%95%E6%9C%BA%E7%89%88.md) |[Qualitis AppConn部署](https://github.com/WeBankFinTech/Qualitis/blob/master/docs/zh_CN/ch1/%E6%8E%A5%E5%85%A5%E5%B7%A5%E4%BD%9C%E6%B5%81%E6%8C%87%E5%8D%97.md) |
398+
| Prophecis | Prophecis0.3.2 | [Prophecis部署](https://github.com/WeBankFinTech/Prophecis/blob/master/docs/zh_CN/QuickStartGuide.md) | [Prophecis AppConn部署](https://github.com/WeBankFinTech/Prophecis/blob/master/docs/zh_CN/Deployment_Documents/Prophecis%20Appconn%E5%AE%89%E8%A3%85%E6%96%87%E6%A1%A3.md) |
399+
| Streamis | Streamis0.2.0 | [Streamis部署](https://github.com/WeBankFinTech/Streamis/blob/main/docs/zh_CN/0.2.0/Streamis%E5%AE%89%E8%A3%85%E6%96%87%E6%A1%A3.md) | [Streamis AppConn部署](https://github.com/WeBankFinTech/Streamis/blob/main/docs/zh_CN/0.2.0/development/StreamisAppConn%E5%AE%89%E8%A3%85%E6%96%87%E6%A1%A3.md) |
400400
| DolphinScheduler | DolphinScheduler1.3.x | [DolphinScheduler部署](https://dolphinscheduler.apache.org/zh-cn/docs/1.3.8/user_doc/standalone-deployment.html) | [DolphinScheduler AppConn部署](DolphinScheduler插件安装文档.md) |

zh_CN/安装部署/DSSUserGuide部署文档.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# 帮助文档部署文档
1+
# 帮助文档部署指南
22

33
> 简介:帮助文档模块属于dss-user-guide模块下,用于提供dss项目相关资料。
44
5-
        在使用dss-user-guide模块时需先部署dss项目服务,可参考dss部署相关文档,dss-user-guide文档同步功能采用定时任务没两小时同步一次,文档更新到系统需要维护一份SUMMARY.md文件用于user-guide模块解析文件所在位置,及解析文档内容。
5+
在使用dss-user-guide模块时需先部署dss项目服务,可参考dss部署相关文档,dss-user-guide文档同步功能采用定时任务每两小时同步一次,文档更新到系统需要维护一份SUMMARY.md文件用于user-guide模块解析文件所在位置,及解析文档内容。
66

77

88

9-
## 1dss-guide-server.properties知识库相关配置说明
9+
## 1. dss-guide-server.properties知识库相关配置说明
1010

1111
### 1.1 参考配置
1212

@@ -38,9 +38,9 @@ guide.sync.model=gitbook
3838

3939

4040

41-
## 2SUMMARY.md文件结构说明
41+
## 2. SUMMARY.md文件结构说明
4242

43-
        SUMMARY.md文件主要用于维护文件所在位置及文件解析之后文件到层级结构
43+
SUMMARY.md文件主要用于维护文件所在位置及文件解析之后文件的层级结构
4444

4545
**例:**
4646

@@ -92,20 +92,21 @@ km
9292
- “空格” + “空格” + “空格” + “空格” + “-” + “空格” + “[内容]” + "()" 表示三级目录
9393
- “空格” + “空格” + “空格” + “空格” + “空格” + “空格” + “-” + “空格” + “[内容]” + "()" 表示四级目录
9494

95-
**注:()中放文件到相对路径,并且文件名不能含有英文字符的()**
95+
**注:( )中存放文件的相对路径,并且文件名不能含有英文括号**
9696

9797

9898

99-
## 3.文件图片说明及配置
99+
## 3. 文件图片说明及配置
100100

101-
        由于部分文档会存在插图,md文件被user-guide模块解析后会将其内容存放到数据库中,图片存放到数据库的只是图片到路径,故在md文档中插入图片的时候需要存放文件到相对路径,然后通过nginx代理到服务器图片存放的文件夹即可。
102-
103-
文件目录结构如下:(假设文件存放子服务器/xxx/test1目录下)
101+
由于部分文档会存在插图,md文件被user-guide模块解析后会将其内容存放到数据库中,图片存放到数据库的只是图片的路径,故在md文档中插入图片的时候需要存放文件的相对路径,然后通过nginx代理到服务器存放图片的文件夹即可。
104102

103+
文件目录结构如下:(假设文件存放在服务器/xxx/test1目录下)
104+
```text
105105
├── 这是一个例子而已.md <br>
106-
│   ├── images <br>
107-
│   │   └── 1.png <br>
108-
├──  SUMMARY.md <br>
106+
├── images <br>
107+
└── 1.png <br>
108+
├──SUMMARY.md <br>
109+
```
109110

110111
**例:**
111112

@@ -125,9 +126,9 @@ location /images {
125126
}
126127
````
127128

128-
**注:这段配置需加在dss服务所在到nginx配置中,需要保证图片到ip:port有服务器一致**
129+
**注:这段配置需加在dss服务所在的nginx配置中,需要保证图片所在服务器的ip和port与DSS服务的一致**
129130

130-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;配置完成之后重启服务即可将文件同步到user-guide中!
131+
**配置完成之后重启服务即可将文件同步到user-guide中!**
131132

132133

133134

zh_CN/安装部署/DSS调试文档.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
title: 调试指引
3-
sidebar_position: 2
4-
---
51

62
# 调试相关
73

@@ -19,20 +15,20 @@ mvn clean Install
1915
```
2016

2117
## step 2 在服务器上部署好DSS服务
22-
若尚未部署DSS可参考部署文档:[DSS单机部署文档](./DSS单机部署文档.md)
18+
若尚未部署DSS可参考部署文档:[DSS单机部署文档](DSS&Linkis一键部署文档单机版.md)
2319

2420
## step 3 打开调试端口
2521

26-
首先需要明确需要调试的包所在的服务,根据需要调试的代码位置,确定其所属的服务。
22+
首先需要明确需要调试的包所在的服务,根据需要调试的代码位置确定其所属的服务。
2723

28-
进入dss部署目录下的该目录:${DSS_HOME}/sbin/ext,修改需要调试的对应服务的启动脚本文件,开启远程调用端口:(以workflow-server服务为例)
24+
其后进入dss部署目录下的 ${DSS_HOME}/sbin/ext 目录,修改需要调试的对应服务的启动脚本文件,开启远程调用端口:(以workflow-server服务为例)
2925

30-
```properties
31-
cd ${DSS_HOME}
26+
```shell
27+
cd ${DSS_HOME}/sbin/ext
3228

33-
vim sbin/ext/dss-workflow-server
29+
vim dss-workflow-server
3430
```
35-
在脚本中找到 DEBUG_PORT 关键字,然后输入需要打开的端口号要从本地能够连通):
31+
在脚本中找到 DEBUG_PORT 关键字,然后输入需要打开的端口号 **(要从本地能够连通)**
3632

3733
![img.png](../Images/安装部署/DSS调试/img.png)
3834

@@ -52,30 +48,31 @@ sh sbin/dss-daemon.sh restart workflow-server
5248

5349
![img_2.png](../Images/安装部署/DSS调试/img_2.png)
5450

55-
## step 5. 开始调试
51+
## step 5 开始调试
5652

5753
在idea右上角点击调试按钮,即可可以开始调试:
5854

5955
![img_3.png](../Images/安装部署/DSS调试/img_3.png)
6056

61-
## step 6. 替换jar包
57+
## step 6 替换jar包
6258

63-
本地修改了代码后,可以打包好对应模块的jar包,然后替换服务器上对应lib的jar。重启服务即可。
59+
本地修改代码后,可以打包好对应模块的jar包,然后替换服务器上对应lib的jar。重启服务即可。
6460

65-
```properties
61+
```shell
6662
cd ${DSS_HOME}
6763

6864
## 往服务器上传jar包
6965
rz -bye
7066

71-
##将上传的jar包拷贝替换原来jar包
67+
## 将上传的jar包拷贝替换原来jar包
7268
cp ${your_jar_name} lib/${jar_path}
7369
```
7470

7571
注:若不清楚该jar在哪些服务的lib中存在,可通过如下命令搜索该jar的所有位置:
76-
```properties
72+
```shell
7773
cd ${DSS_HOME}
78-
###搜索lib目录下的所有dss-orchestrator-common-*.jar包
74+
75+
## 搜索lib目录下的所有dss-orchestrator-common-*.jar包
7976
find lib/ -name "*dss-orchestrator-common*"
8077
```
8178

zh_CN/安装部署/DolphinScheduler插件安装文档.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
**请注意:目前 `DolphinSchedulerAppConn` 只支持适配 DolphinScheduler1.3.X。**
88

9-
关于 `DolphinScheduler` 的安装部署,请参考:[`DolphinScheduler` 安装部署文档](https://dolphinscheduler.apache.org/zh-cn/docs/1.3.8/user_doc/standalone-deployment.html)
9+
关于 `DolphinScheduler` 的安装部署,请参考:`DolphinScheduler` [安装部署文档](https://dolphinscheduler.apache.org/zh-cn/docs/1.3.8/user_doc/standalone-deployment.html)
1010

1111
## 2. 下载和编译
1212

zh_CN/安装部署/ExchangisAppConn插件安装文档.md

Lines changed: 0 additions & 86 deletions
This file was deleted.

0 commit comments

Comments
 (0)