We create LKIP-24 https://docs.qq.com/doc/DVUdVUHVxbEtXTUxa about linkis
official website documentation refactoring
After an initial online meeting to communicate and discuss,
There are the following comments:

- Quick Start -> Quick Experience Added sandbox environment guide document
- Deployment guide dss integrated deployment link
- Scope of engine version adaptation Guidelines for adaptation and
modification, provide guidelines for modification documents refer to
CDH/HDP/Spark3
- Consider adding a decision diagram to let users choose according to the
actual situation and finally choose those installation methods
- Need to add common parameter modification instructions according to the
scenario, such as how to open the test mode, LDAP configuration scenario,
engine storage directory adjustment, etc.
- User manual revised to use guide
- Use swagger and put it under the API column
- The use of Linkis-Cli is modified to be used in shell mode
- Increase the use of JDBC SDK
- The example module supplements the common SDK usage example code, and can
be considered to be placed in a GitHub repository separately
- Added how to read this manual document (quickly understand the general
content of each document module)
- Engine documentation Different version compilation related to the end of
the content
- Removed overview leaf for some categories
- Classification and titles of QA documents
- Menu bar Document version drop-down list to keep the last 3 versions
Historical versions are placed on the history summary page separately
https://linkis.apache.org/zh-CN/versions

Welcome to put forward your suggestions for discussion



- 快速上手-> 快速体验  增加沙箱环境指引文档
- 部署指南  dss的整合部署链接
- 引擎版本适配范围  适配修改的指引, 给出指引修改文档参考 CDH/HDP/Spark3
- 考虑增加决策图  让用户根据实际情况选择 最终选择那些安装方式
- 需要增加常用参数修改说明 按场景来      如 如何开启测试模式  LDAP 配置场景  引擎存放目录调整等
- 用户手册 修改为 使用指南
- Swagger使用 放到 API 栏目下
- Linkis-Cli 的使用  修改为 shell 方式使用
- 增加 JDBC SDK的使用
- example 模块 补充常见的sdk使用示例代码 可以考虑单独放到一个github库中
- 增加如何阅读本手册 文档(快速了解各文档模块的大体内容)
- 引擎文档  差异化版本编译相关的放到内容最后
- 部分类别去掉总览叶
- QA 文档的分类和标题
- 菜单栏 文档版本下拉列表 至保留最近3个版本 历史版本单独放到历史汇总页面中
https://linkis.apache.org/zh-CN/versions

Best Regards!
Chen Xia.

Reply via email to