Merge pull request #34 from yuankang134/1.1.0

add Workspaces manual and DSSUserGuide deploy document

Author: zqburde

zh_CN/Images/使用文档/workspace/ws_img1.png

@@ -0,0 +1,29 @@
+# 1.工作空间角色权限介绍 
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;在项目导向的工作空间中，可以添加任何部门的成员；在部门导向的工作空间中，只可以添加本部门的成员。<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**管理台：**
+- 工作空间创建者的默认角色是拥有者，可以委托一名或多名管理员对工作空间进行管理。<br>
+- 只有工作空间的管理员可以进入【管理台】模块，对该工作空间的基本信息和权限信息进行相应管理。<br>
+- 工作空间的默认角色包括拥有者、管理员、开发用户、运维用户、分析用户、运营用户、数据服务用户、访客。<br>
+  - 拥有者：拥有最高权限，拥有该工作空间内所有功能的操作权限，可以删除该工作空间；
+  - 管理员：拥有该工作空间内所有功能的操作权限；
+  - 开发用户：拥有数据接入、数据质量、应用开发、测试环境任务发布、生产环境任务提交等权限；
+  - 运维用户：拥有数据质量、资源配置、测试环境任务发布、生产任务审批发布等权限；
+  - 分析用户：拥有数据接入、数据分析等权限；
+  - 运营用户：拥有数据分析等权限；
+  - 数据服务用户：拥有数据接入、数据服务等权限；
+  - 访客：拥有工作空间内所有模块的只读权限，不可编辑或执行；
+
+# 2.工作空间页面介绍 
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;工作空间页面包含：**项目列表**、**应用开发流程**、**菜单**、**常见问题**四部分。<br>
+- 项目列表：在用户进入dss后，可以选择不同的工作空间来创建自己的项目，选择不同的工作空间会展示所创建的项目列表。
+![](../Images/使用文档/workspace/ws_img1.png)
+- 应用开发流程：其中包含了**需求**（不可用）、**设计**（不可用）、**开发**、**调试**、**生产**,点击对应功能下的按钮可跳转到对应的功能或查看对应的示例
+![](../Images/使用文档/workspace/ws_img2.png)
+- 菜单：点击UDF管理，可进入linkis管理台进行资源管理，可以新增函数或新增UDF
+![](../Images/使用文档/workspace/ws_img3.png)
+
+# 3.创建项目
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;在项目空间列表中，点击创建项目，可以更具自己的需要配置并新增项目
+![](../Images/使用文档/workspace/ws_img5.png)
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;通过点击项目的管理按钮可修改项目的基本信息，只有管理员才能够删除项目
+![](../Images/使用文档/workspace/ws_img6.png)

zh_CN/Images/使用文档/workspace/ws_img2.png

@@ -0,0 +1,141 @@
+# 帮助文档部署文档
+
+> 简介:帮助文档模块属于dss-user-guide模块下，用于提供dss项目相关资料。
+
+        在使用dss-user-guide模块时需先部署dss项目服务，可参考dss部署相关文档，dss-user-guide文档同步功能采用定时任务没两小时同步一次，文档更新到系统需要维护一份SUMMARY.md文件用于user-guide模块解析文件所在位置，及解析文档内容。
+
+
+
+## 1、dss-guide-server.properties知识库相关配置说明
+
+### 1.1 参考配置
+
+````properties
+#gitbook
+#文档所存放的服务器ip地址
+target.ip.address=127.0.0.1
+#文档所在服务器路径
+host.gitbook.path=/appcom/Install/ApacheInstall/gitbook_books
+#需要同步到服务器
+target.gitbook.path=/appcom/Install/ApacheInstall
+#用于忽略解析km下到目录
+summary.ignore.model=km
+#知识库同步方式：gitbook database
+guide.sync.model=gitbook
+````
+
+### 1.2 DSS1.1.0配置
+
+````properties
+#gitbook
+#文档所存放的服务器ip地址
+target.ip.address=127.0.0.1
+#文档所在服务器路径(目录配置到summary.md文件所在目录即可，例：/xxx/test1/SUMMARY.md)
+host.gitbook.path=/xxx/test1
+#Dss1.1.0不支持gitbook方式同步，故采取database
+guide.sync.model=gitbook
+````
+
+
+
+## 2、SUMMARY.md文件结构说明
+
+        SUMMARY.md文件主要用于维护文件所在位置及文件解析之后文件到层级结构
+
+**例：**
+
+````SUMMARY.md
+guide
+- [学习引导]()
+/workspaceManagement
+  - [工作空间管理]()
+    - [question]()
+      - [什么用户可以进入工作空间管理](/学习引导/工作空间管理/question/什么用户可以进入工作空间管理.md)
+    - [step]()
+      - [权限管理页面](/学习引导/工作空间管理/step/权限管理页面.md)
+      - [用户权限管理](/学习引导/工作空间管理/step/用户权限管理.md)
+/workspaceHome
+  - [工作空间页面]()
+    - [question]()
+      - [为什么看不到应用商店了](/学习引导/工作空间页面/question/为什么看不到应用商店了.md)
+    - [step]()
+      - [工作空间页面介绍](/学习引导/工作空间页面/step/工作空间页面介绍.md)
+/workflow
+  - [工作流]()
+    - [step]()
+      - [页面介绍](/学习引导/工作流/step/页面介绍.md)
+knowledge
+- [知识库]()
+  - [Demo案例]()
+    - [开发](/知识库/Demo案例/开发.md)
+    - [生产](/知识库/Demo案例/生产.md)
+    - [调试](/知识库/Demo案例/调试.md)
+  - [Dss常见问题]()
+    - [用户权限问题]()
+      - [新人权限申请](/知识库/DSS常见问题/用户权限问题/新人权限申请.md)
+      - [SparkHive等组件报权限问题](/知识库/DSS常见问题/用户权限问题/SparkHive等组件报权限问题.md)   
+      - [没有队列权限不能提交到队列](/知识库/DSS常见问题/用户权限问题/没有队列权限不能提交到队列.md)
+km
+- [km]()
+  - [BDAP-IDE2.1.2功能介绍](/km/BDAP-IDE2.1.2功能介绍.md)
+  - [BDAP共享目录问题汇总](/km/BDAP共享目录问题汇总.md)
+````
+
+**说明：**
+
+![企业微信截图_20220623173645](../Images/安装部署/DSSUserGuide部署/userguide_1.png)
+
+**目录结构说明：**
+
+- “-” + “空格” + “[内容]” + "()" 表示一级目录
+- “空格” + “空格” + “-” + “空格” + “[内容]” + "()" 表示二级目录
+- “空格” + “空格” + “空格” + “空格” + “-” + “空格” + “[内容]” + "()" 表示三级目录
+- “空格” + “空格” + “空格” + “空格” + “空格” + “空格” + “-” + “空格” + “[内容]” + "()" 表示四级目录
+
+**注：()中放文件到相对路径，并且文件名不能含有英文字符的()**
+
+
+
+## 3.文件图片说明及配置
+
+        由于部分文档会存在插图，md文件被user-guide模块解析后会将其内容存放到数据库中，图片存放到数据库的只是图片到路径，故在md文档中插入图片的时候需要存放文件到相对路径，然后通过nginx代理到服务器图片存放的文件夹即可。
+
+文件目录结构如下：(假设文件存放子服务器/xxx/test1目录下)
+
+├── 这是一个例子而已.md <br>
+│   ├── images  <br>
+│   │   └── 1.png <br>
+├──  SUMMARY.md  <br>
+
+**例：**
+
+````md
+这是一个例子而已！！！
+下面是图片
+![我是图片](/images/1.png)
+````
+
+**nginx配置：**
+
+````nginx
+# 图片所在服务器路径
+location /images {
+   root /xxx/test1/;
+   autoindex on;
+}        
+````
+
+**注：这段配置需加在dss服务所在到nginx配置中，需要保证图片到ip:port有服务器一致。**
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;配置完成之后重启服务即可将文件同步到user-guide中！
+
+
+
+
+
+
+
+
+
+
+

zh_CN/Images/使用文档/workspace/ws_img3.png

@@ -1,54 +1,26 @@
 ## DSS User Document
 
-## 前言
-
-    DSS1.1.0 是 DSS 将会长期维护的里程碑版本，在 DSS0.x 的基础上进行了大量优化和重构，社区伙伴们在使用的过程中有任何问题和建议，可以随时给 DSS 提 issue 或是在社区群提问。
-
-    同时也希望和社区伙伴们一起持续优化 DSS 的用户体验和文档仓库。
-
-## 概述
-
-DSS 作为数据应用开发管理集成框架，将满足从数据交换、脱敏清洗、分析挖掘、质量检测、可视化展现、定时调度到数据输出应用等，数据应用开发全流程场景需求。
+## 动机
+    DSS1.x版本是一个里程碑版本，在DSS0.x的基础上进行了大量优化和重构，由于篇幅有限，只能涵盖DSS的基本使用流程，更多的操作使用细节，希望和社区伙伴们一起完善优化，在使用的过程中有任何问题和建议，可以随时联系微众银行大数据平台的相关社区开源人员，我们致力于打造更好的一站式大数据套件，为大数据开源生态贡献自己的力量。
 
-基于 DSS 已内嵌的应用组件，默认所具备的能力如下：
-
-- [DSS 如何新增用户](DSS新增用户方式.md)
-- [超级管理员使用介绍](超级管理员功能.md)
-- [工作空间管理使用介绍]()
-- [Scriptis 数据开发探索使用介绍](Scriptis使用文档.md)
-- [DSS 工作流使用介绍](工作流使用文档.md)
-- [数据服务使用介绍](数据服务使用手册.md)
-- [Linkis 管理台使用介绍](https://linkis.apache.org/zh-CN/docs/latest/user_guide/console_manual)
-- [调度中心使用介绍](调度中心使用文档.md)
-
-更具体的，您可以通过以下 6 步来开发一个数据应用：
-
-- 步骤1：超级管理员为部门（或业务）创建工作空间；
-- 步骤2：为工作空间设置工作空间管理员；
-- 步骤3：工作空间管理员为工作空间添加用户，分配角色；
-- 步骤4：用户创建项目，在项目中创建工作流；
-- 步骤5：在工作流中开发数据应用。可在线编写Spark Scala，Pyspark、HiveQL、Spark-sql，Python，Shell，JDBC 等脚本作业，或是 Visualis，Qualitis，Exchangis 等第三方应用作业；
-- 步骤6：发布工作流到调度系统，执行工作流调度；
+## 前言
+    DSS1.x版本对前端页面交互进行了重构和优化，本文档是DSS的用户使用手册，涵盖了DSS1.0的基本使用流程，更多的操作使用细节，请参考各个模块的的文档。
+    用户文档主要分为以下几个文档，分别是：  
+1. [Scriptis使用文档]()  
+2. [工作流使用文档]()
+3. [数据服务使用文档]()
+4. [Linkis管理台使用手册]()
 
 ## 管理模块介绍
-
 ## 登录首页
-
     为了方便用户使用，系统默认通过Linkis的Linux部署用户进行登录，如使用hadoop部署的Linkis和DSS，可以直接通过用户：hadoop，密码：hadoop(密码就是用户名)登录。 输入DSS前端地址后，127.0.0.1:8088 输入用户名密码：hadoop hadoop，即可登录，登录页提供DSS用户访问权限验证功能。
-
-![](./images/loginpage.png)
-
+![](./images/loginpage.png)  
 *注意： 如果要支持多用户登录，DSS的用户登录依赖Linkis，需要在linkis-GateWay的配置里面进行配置，Linkis-GateWay默认支持LDAP。*
 
 ## 工作空间
-
     进入到工作空间页面，可以创建和管理工作空间。工作空间是DSS最顶层的概念，比较直观的例子比如，工作空间可以是一个部门，一个业务线，或者是一个组织，用来管理数据应用，包括人员，工程，或者组件，每个工作空间会有工作空间管理员的角色权限，可以对工作空间的进行管理，控制工作空间的组件和人员权限。
-
 ![](./images/workspace.png)  
 
 ## 工程管理
-
     在进入相应的工作空间后，会跳转到工程首页，在工程首页，可以创建工程，在实际的开发生产中，工程往往被用来管理开发一类数据应用，包括工作流，单任务等，每个工作空间下的工程互相隔离。在实际应用中，为每一个数据应用划分一个工程，是较为理想的方式。
-
-![](./images/project.png) 
-
+![](./images/project.png)