Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

建议修订单机版部署文档 #75

Open
CHN-STUDENT opened this issue Aug 20, 2020 · 0 comments
Open

建议修订单机版部署文档 #75

CHN-STUDENT opened this issue Aug 20, 2020 · 0 comments

Comments

@CHN-STUDENT
Copy link

RT,
在部署单机版中发现以下问题
1、克隆的源码与API文档不符,不注意修改的话部署会失败

https://docs.opendevops.cn/zh/guide/install/local/#api%E7%BD%91%E5%85%B3 和部署代码不一样,需要自己修改。

2、文档存在setting.py和shell脚本混写的形式,会产生理解歧义

https://docs.opendevops.cn/zh/guide/install/local/#%E8%B5%84%E4%BA%A7%E7%AE%A1%E7%90%86 的通过 docker 安装 webterminal 过程,没有注明需要安装 docker,同时下面的 WEB_TERMINAL 变量应该是setting.py的配置,容易误解成shell脚本的变量。

3、文档需要在修改的地方特别标注,否则部署也会失效
特别需要修改的地方建议加红加粗,因为部署文档过长,有时候可能就容易忽略。

另外部署建议提供可下载脚本而不是自己复制粘贴脚本。

感谢。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant