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