已关闭
【文档整改】 fix comments in installation docs (Chinese and English) #309
luolong创建于  9月8日关闭于  9月9日
luolong成员
9月8日 创建

问题描述

安装部署文档中存在以下描述不准确/缺失的问题,需要修复:

1. 安装部署概念和流程文档

  • 问题:未说明 openFuyao 管理面在不同章节中指代的不同端口含义
  • 修复:在中文和英文文档中补充说明——引导集群相关章节中管理面指引导节点前端界面(端口 30010),非引导集群相关章节中指集群前端界面(端口 31616)

2. 通过前台(Web页面)安装业务集群文档

  • 问题1:缺少高级配置中附加件需选择 openFuyao Cores 的说明
  • 修复1:补充说明——高级配置中的附加件需要选择 openFuyao Cores,选择此选项后安装的业务集群才会有 openFuyao 管理面
  • 问题2:缺少集群状态字段的完整描述
  • 修复2:补充集群状态说明——安装中、扩容中、检查中、异常、健康,并说明各状态出现的场景及含义
  • 问题3:文档末尾多余空行
  • 修复3:清理末尾多余空行

3. 前置/后置处理脚本自定义配置文档

  • 问题1:Preprocess 章节中"bkeagent控到命令"有笔误
  • 修复1:修正为"bkeagent监控到命令"
  • 问题2:Preprocess 和 Postprocess 章节中参数名 nodeIP 与文档其他位置使用的 NODE_IP 不一致
  • 修复2:统一修正为 NODE_IP

影响范围

  • docs/zh/cluster_installation_guide/read_before_installation/installation_process.md
  • docs/en/cluster_installation_guide/read_before_installation/installation_process.md
  • docs/zh/cluster_installation_guide/service_cluster_installation/service_cluster_installation_on_the_management_plane.md
  • docs/en/cluster_installation_guide/service_cluster_installation/service_cluster_installation_on_the_management_plane.md
  • docs/zh/cluster_installation_guide/service_management_cluster_configuration/preprocessing_and_postprocessing_guide.md
  • docs/en/cluster_installation_guide/service_management_cluster_configuration/preprocessing_and_postprocessing_guide.md

关联 PR

  • #226
likedislike
openFuyao-botopenFuyao-bot成员
9月8日 添加了label:sig/sig-Installation
openFuyao-bot
openFuyao-bot成员
9月8日 评论:

欢迎来到 openFuyao 社区

Hey @luolong817 , 感谢你对社区的贡献.

机器人使用手册

有关指令的使用,可以点击 此处 查看详情。开发人员可以在每个PR或Issue下方评论特定指令来触发机器人任务。您可以自助配置此仓库的 PR 合并规则,更多详情,请参阅此处。

联系指引

有疑问可以联系 SIG: sig-Installation ,
维护者是: @foxbit, @javadoors, @regandy, @xuyouhong, @zqw1 ,
审核者是: @piamposer-li .

likedislike
Lluolong成员
9月8日 修改标题为 “【文档整改】 fix comments in installation docs (Chinese and English)”,原标题为“fix: fix comments in installation docs (Chinese and English)”
Lluolong成员
9月8日 关联了pull request:fix: fix comments
Lluolong成员
9月9日 issue状态由 开启 改变为 待测试
Lluolong成员
9月9日 issue状态由 待测试 改变为 已完成
Lluolong成员
9月9日 关闭了 issue
lihangyulihangyu成员
9月13日 关联了看板:openFuyao - v26.09问题单
lihangyulihangyu成员
9月13日 关联了里程碑:v26.09