Merge pull request #38 from zqburde/1.1.0

Optimize deployment doc and delete unnecessary appconn doc

Author: zqburde

zh_CN/Images/安装部署/ExchangisAppConn部署/DSS-Exchangis.png

@@ -394,7 +394,7 @@ HIVE_PASSWORD=xxx
   | Schedulis | Schedulis0.7.0 | [Schedulis部署](https://github.com/WeBankFinTech/Schedulis/blob/master/docs/schedulis_deploy_cn.md) | [Schedulis AppConn部署](SchedulisAppConn插件安装文档.md)|
   | 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)|
   | 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) |
-  | 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)   |
-  | Prophecis  | Prophecis0.3.2 |   [Prophecis部署]() | [Prophecis AppConn部署]() |
-  | Streamis  | Streamis0.2.0 |  [Streamis部署]()       | [Streamis AppConn部署]() |
+  | 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) |
+  | 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) |
+  | 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) |
   | 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/Images/安装部署/QualitisAppConn部署/dss-qualitis.png

@@ -1,12 +1,12 @@
-# 帮助文档部署文档
+# 帮助文档部署指南
 
 > 简介:帮助文档模块属于dss-user-guide模块下，用于提供dss项目相关资料。
 
-        在使用dss-user-guide模块时需先部署dss项目服务，可参考dss部署相关文档，dss-user-guide文档同步功能采用定时任务没两小时同步一次，文档更新到系统需要维护一份SUMMARY.md文件用于user-guide模块解析文件所在位置，及解析文档内容。
+在使用dss-user-guide模块时需先部署dss项目服务，可参考dss部署相关文档，dss-user-guide文档同步功能采用定时任务每两小时同步一次，文档更新到系统需要维护一份SUMMARY.md文件用于user-guide模块解析文件所在位置，及解析文档内容。
 
 
 
-## 1、dss-guide-server.properties知识库相关配置说明
+## 1. dss-guide-server.properties知识库相关配置说明
 
 ### 1.1 参考配置
 
@@ -38,9 +38,9 @@ guide.sync.model=gitbook
 
 
 
-## 2、SUMMARY.md文件结构说明
+## 2. SUMMARY.md文件结构说明
 
-        SUMMARY.md文件主要用于维护文件所在位置及文件解析之后文件到层级结构
+SUMMARY.md文件主要用于维护文件所在位置及文件解析之后文件的层级结构
 
 **例：**
 
@@ -92,20 +92,21 @@ km
 - “空格” + “空格” + “空格” + “空格” + “-” + “空格” + “[内容]” + "()" 表示三级目录
 - “空格” + “空格” + “空格” + “空格” + “空格” + “空格” + “-” + “空格” + “[内容]” + "()" 表示四级目录
 
-**注：()中放文件到相对路径，并且文件名不能含有英文字符的()**
+**注：( )中存放文件的相对路径，并且文件名不能含有英文括号**
 
 
 
-## 3.文件图片说明及配置
+## 3. 文件图片说明及配置
 
-        由于部分文档会存在插图，md文件被user-guide模块解析后会将其内容存放到数据库中，图片存放到数据库的只是图片到路径，故在md文档中插入图片的时候需要存放文件到相对路径，然后通过nginx代理到服务器图片存放的文件夹即可。
-
-文件目录结构如下：(假设文件存放子服务器/xxx/test1目录下)
+由于部分文档会存在插图，md文件被user-guide模块解析后会将其内容存放到数据库中，图片存放到数据库的只是图片的路径，故在md文档中插入图片的时候需要存放文件的相对路径，然后通过nginx代理到服务器存放图片的文件夹即可。
 
+文件目录结构如下：(假设文件存放在服务器/xxx/test1目录下)
+```text
 ├── 这是一个例子而已.md <br>
-│   ├── images  <br>
-│   │   └── 1.png <br>
-├──  SUMMARY.md  <br>
+    ├── images  <br>
+        └── 1.png <br>
+├──SUMMARY.md  <br>
+```
 
 **例：**
 
@@ -125,9 +126,9 @@ location /images {
 }        
 ````
 
-**注：这段配置需加在dss服务所在到nginx配置中，需要保证图片到ip:port有服务器一致。**
+**注：这段配置需加在dss服务所在的nginx配置中，需要保证图片所在服务器的ip和port与DSS服务的一致。**
 
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;配置完成之后重启服务即可将文件同步到user-guide中！
+**配置完成之后重启服务即可将文件同步到user-guide中！**
 
 
 

zh_CN/Images/安装部署/QualitisAppConn部署/workflow-qualitis.png

@@ -1,7 +1,3 @@
----
-title: 调试指引
-sidebar_position: 2
----
 
 # 调试相关
 
@@ -19,20 +15,20 @@ mvn clean Install
 ```
 
 ## step 2 在服务器上部署好DSS服务
-若尚未部署DSS可参考部署文档：[DSS单机部署文档](./DSS单机部署文档.md)
+若尚未部署DSS可参考部署文档：[DSS单机部署文档](DSS&Linkis一键部署文档单机版.md)
 
 ## step 3 打开调试端口
 
-首先需要明确需要调试的包所在的服务，根据需要调试的代码位置,确定其所属的服务。
+首先需要明确需要调试的包所在的服务，根据需要调试的代码位置，确定其所属的服务。
 
-进入dss部署目录下的该目录：${DSS_HOME}/sbin/ext，修改需要调试的对应服务的启动脚本文件，开启远程调用端口：（以workflow-server服务为例）
+其后进入dss部署目录下的 ${DSS_HOME}/sbin/ext 目录，修改需要调试的对应服务的启动脚本文件，开启远程调用端口：（以workflow-server服务为例）
 
-```properties
-cd ${DSS_HOME}
+```shell
+cd ${DSS_HOME}/sbin/ext
 
-vim sbin/ext/dss-workflow-server
+vim dss-workflow-server
 ```
-在脚本中找到 DEBUG_PORT 关键字，然后输入需要打开的端口号（要从本地能够连通）：
+在脚本中找到 DEBUG_PORT 关键字，然后输入需要打开的端口号 **(要从本地能够连通)**
 
 ![img.png](../Images/安装部署/DSS调试/img.png)
 
@@ -52,30 +48,31 @@ sh sbin/dss-daemon.sh restart workflow-server
 
 ![img_2.png](../Images/安装部署/DSS调试/img_2.png)
 
-## step 5. 开始调试
+## step 5 开始调试
 
 在idea右上角点击调试按钮，即可可以开始调试：
 
 ![img_3.png](../Images/安装部署/DSS调试/img_3.png)
 
-## step 6. 替换jar包
+## step 6 替换jar包
 
-本地修改了代码后，可以打包好对应模块的jar包，然后替换服务器上对应lib的jar。重启服务即可。
+本地修改代码后，可以打包好对应模块的jar包，然后替换服务器上对应lib的jar。重启服务即可。
 
-```properties
+```shell
 cd ${DSS_HOME}
 
 ## 往服务器上传jar包
 rz -bye
 
-##将上传的jar包拷贝替换原来jar包
+## 将上传的jar包拷贝替换原来jar包
 cp ${your_jar_name} lib/${jar_path}
 ```
 
 注：若不清楚该jar在哪些服务的lib中存在，可通过如下命令搜索该jar的所有位置：
-```properties
+```shell
 cd ${DSS_HOME}
-###搜索lib目录下的所有dss-orchestrator-common-*.jar包
+
+## 搜索lib目录下的所有dss-orchestrator-common-*.jar包
 find lib/ -name "*dss-orchestrator-common*"
 ```
 

zh_CN/Images/安装部署/VisualisAppConn部署/DSS-Visualis.png

@@ -6,7 +6,7 @@
 
 **请注意：目前 `DolphinSchedulerAppConn` 只支持适配 DolphinScheduler1.3.X。**
 
-关于 `DolphinScheduler` 的安装部署，请参考：[`DolphinScheduler` 安装部署文档](https://dolphinscheduler.apache.org/zh-cn/docs/1.3.8/user_doc/standalone-deployment.html)
+关于 `DolphinScheduler` 的安装部署，请参考：`DolphinScheduler` [安装部署文档](https://dolphinscheduler.apache.org/zh-cn/docs/1.3.8/user_doc/standalone-deployment.html)
 
 ## 2. 下载和编译