Skip to content

Commit 67d8af6

Browse files
committed
add Workspaces manual and DSSUserGuide deploy document
1 parent 4356db8 commit 67d8af6

File tree

8 files changed

+166
-0
lines changed

8 files changed

+166
-0
lines changed
163 KB
Loading
105 KB
Loading
107 KB
Loading
314 KB
Loading
214 KB
Loading
116 KB
Loading
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# 1.工作空间角色权限介绍
2+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;在项目导向的工作空间中,可以添加任何部门的成员;在部门导向的工作空间中,只可以添加本部门的成员。<br>
3+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**管理台:**
4+
- 工作空间创建者的默认角色是拥有者,可以委托一名或多名管理员对工作空间进行管理。<br>
5+
- 只有工作空间的管理员可以进入【管理台】模块,对该工作空间的基本信息和权限信息进行相应管理。<br>
6+
- 工作空间的默认角色包括拥有者、管理员、开发用户、运维用户、分析用户、运营用户、数据服务用户、访客。<br>
7+
- 拥有者:拥有最高权限,拥有该工作空间内所有功能的操作权限,可以删除该工作空间;
8+
- 管理员:拥有该工作空间内所有功能的操作权限;
9+
- 开发用户:拥有数据接入、数据质量、应用开发、测试环境任务发布、生产环境任务提交等权限;
10+
- 运维用户:拥有数据质量、资源配置、测试环境任务发布、生产任务审批发布等权限;
11+
- 分析用户:拥有数据接入、数据分析等权限;
12+
- 运营用户:拥有数据分析等权限;
13+
- 数据服务用户:拥有数据接入、数据服务等权限;
14+
- 访客:拥有工作空间内所有模块的只读权限,不可编辑或执行;
15+
16+
# 2.工作空间页面介绍
17+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;工作空间页面包含:**项目列表****应用开发流程****菜单****常见问题**四部分。<br>
18+
- 项目列表:在用户进入dss后,可以选择不同的工作空间来创建自己的项目,选择不同的工作空间会展示所创建的项目列表。
19+
![](../Images/使用文档/workspace/ws_img1.png)
20+
- 应用开发流程:其中包含了**需求**(不可用)、**设计**(不可用)、**开发****调试****生产**,点击对应功能下的按钮可跳转到对应的功能或查看对应的示例
21+
![](../Images/使用文档/workspace/ws_img2.png)
22+
- 菜单:点击UDF管理,可进入linkis管理台进行资源管理,可以新增函数或新增UDF
23+
![](../Images/使用文档/workspace/ws_img3.png)
24+
25+
# 3.创建项目
26+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;在项目空间列表中,点击创建项目,可以更具自己的需要配置并新增项目
27+
![](../Images/使用文档/workspace/ws_img5.png)
28+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;通过点击项目的管理按钮可修改项目的基本信息,只有管理员才能够删除项目
29+
![](../Images/使用文档/workspace/ws_img6.png)
Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
# 帮助文档部署文档
2+
3+
> 简介:帮助文档模块属于dss-user-guide模块下,用于提供dss项目相关资料。
4+
5+
​ 在使用dss-user-guide模块时需先部署dss项目服务,可参考dss部署相关文档,dss-user-guide文档同步功能采用定时任务没两小时同步一次,文档更新到系统需要维护一份SUMMARY.md文件用于user-guide模块解析文件所在位置,及解析文档内容。
6+
7+
8+
9+
## 1、dss-guide-server.properties知识库相关配置说明
10+
11+
### 1.1 参考配置
12+
13+
````properties
14+
#gitbook
15+
#文档所存放的服务器ip地址
16+
target.ip.address=127.0.0.1
17+
#文档所在服务器路径
18+
host.gitbook.path=/appcom/Install/ApacheInstall/gitbook_books
19+
#需要同步到服务器
20+
target.gitbook.path=/appcom/Install/ApacheInstall
21+
#用于忽略解析km下到目录
22+
summary.ignore.model=km
23+
````
24+
25+
### 1.2 建议配置
26+
27+
````properties
28+
#gitbook
29+
#文档所存放的服务器ip地址
30+
target.ip.address=127.0.0.1
31+
#文档所在服务器路径(目录配置到summary.md文件所在目录即可,例:/xxx/test1/SUMMARY.md)
32+
host.gitbook.path=/xxx/test1
33+
````
34+
35+
36+
37+
## 2、SUMMARY.md文件结构说明
38+
39+
​ SUMMARY.md文件主要用于维护文件所在位置及文件解析之后文件到层级结构
40+
41+
**例:**
42+
43+
````SUMMARY.md
44+
guide
45+
- [学习引导]()
46+
/workspaceManagement
47+
- [工作空间管理]()
48+
- [question]()
49+
- [什么用户可以进入工作空间管理](/学习引导/工作空间管理/question/什么用户可以进入工作空间管理.md)
50+
- [step]()
51+
- [权限管理页面](/学习引导/工作空间管理/step/权限管理页面.md)
52+
- [用户权限管理](/学习引导/工作空间管理/step/用户权限管理.md)
53+
/workspaceHome
54+
- [工作空间页面]()
55+
- [question]()
56+
- [为什么看不到应用商店了](/学习引导/工作空间页面/question/为什么看不到应用商店了.md)
57+
- [step]()
58+
- [工作空间页面介绍](/学习引导/工作空间页面/step/工作空间页面介绍.md)
59+
/workflow
60+
- [工作流]()
61+
- [step]()
62+
- [页面介绍](/学习引导/工作流/step/页面介绍.md)
63+
knowledge
64+
- [知识库]()
65+
- [Demo案例]()
66+
- [开发](/知识库/Demo案例/开发.md)
67+
- [生产](/知识库/Demo案例/生产.md)
68+
- [调试](/知识库/Demo案例/调试.md)
69+
- [Dss常见问题]()
70+
- [用户权限问题]()
71+
- [新人权限申请](/知识库/DSS常见问题/用户权限问题/新人权限申请.md)
72+
- [SparkHive等组件报权限问题](/知识库/DSS常见问题/用户权限问题/SparkHive等组件报权限问题.md)
73+
- [没有队列权限不能提交到队列](/知识库/DSS常见问题/用户权限问题/没有队列权限不能提交到队列.md)
74+
km
75+
- [km]()
76+
- [BDAP-IDE2.1.2功能介绍](/km/BDAP-IDE2.1.2功能介绍.md)
77+
- [BDAP共享目录问题汇总](/km/BDAP共享目录问题汇总.md)
78+
````
79+
80+
**说明:**
81+
82+
![企业微信截图_20220623173645](..\Images\安装部署\DSSUserGuide部署\userguide_1.png)
83+
84+
**目录结构说明:**
85+
86+
- “-” + “空格” + “[内容]” + "()" 表示一级目录
87+
- “空格” + “空格” + “-” + “空格” + “[内容]” + "()" 表示二级目录
88+
- “空格” + “空格” + “空格” + “空格” + “-” + “空格” + “[内容]” + "()" 表示三级目录
89+
- “空格” + “空格” + “空格” + “空格” + “空格” + “空格” + “-” + “空格” + “[内容]” + "()" 表示四级目录
90+
91+
**注:()中放文件到相对路径,并且文件名不能含有英文字符的()**
92+
93+
94+
95+
## 3.文件图片说明及配置
96+
97+
​ 由于部分文档会存在插图,md文件被user-guide模块解析后会将其内容存放到数据库中,图片存放到数据库的只是图片到路径,故在md文档中插入图片的时候需要存放文件到相对路径,然后通过nginx代理到服务器图片存放的文件夹即可。
98+
99+
文件目录结构如下:(假设文件存放子服务器/xxx/test1目录下)
100+
101+
├── 这是一个例子而已.md <br>
102+
│   ├── images <br>
103+
│   │   └── 1.png <br>
104+
├──  SUMMARY.md <br>
105+
106+
**例:**
107+
108+
````md
109+
这是一个例子而已!!!
110+
下面是图片
111+
![我是图片](/images/1.png)
112+
````
113+
114+
**nginx配置:**
115+
116+
````nginx
117+
# 图片所在服务器路径
118+
location /images {
119+
root /xxx/test1/;
120+
autoindex on;
121+
}
122+
````
123+
124+
**注:这段配置需加在dss服务所在到nginx配置中,需要保证图片到ip:port有服务器一致。**
125+
126+
配置完成之后重启服务即可将文件同步到user-guide中!
127+
128+
129+
130+
131+
132+
133+
134+
135+
136+
137+

0 commit comments

Comments
 (0)