这份模板用于给某一个平台单独建立说明页,方便长期维护。
简要说明它的定位:
- 为什么部署它
- 它解决什么问题
- 它在整套平台中的位置是什么
例如:
- 日常使用场景
- 维护用途
- 是否高频使用
- 是否对外开放
- 部署方式:
- 运行方式:
- 反向代理:
- 数据库类型:
- 是否使用 systemd:
- 访问地址:
- 是否需要登录:
- 是否开放注册:
- 管理员入口:
- 数据目录:
- 配置文件路径:
- 数据库位置:
- 服务名:
例如:
- 是否建议近期升级
- 是否要谨慎变更
- 是否属于关键平台
- 是否建议优先备份
这里记录特殊说明,例如:
- 已知兼容问题
- 当前 workaround
- 不建议随便动的部分
- 后续优化方向