已合并
【docs】设计文档优化:扩缩容文档合一为 scaling.md、主备倒换设计文档归位 #679
【docs】设计文档优化:扩缩容文档合一为 scaling.md、主备倒换设计文档归位 #679
已合并
jason lyu创建于 8月6日
jason lyu
jason lyu成员
8月6日

变更说明

关联 ISSUE:#450 [Documentation|文档反馈]: 设计文档优化:扩缩容文档合一为 scaling.md、主备倒换设计文档归位

  1. 文档归位docs/zh/design/standby.md 移至 docs/zh/design/fault_tolerance/standby.md,与 fault_manager、precision_detection 等容错设计文档归入同组,并修正文档内图片相对路径(../imgs/../../imgs/)。
  2. 扩缩容文档合一design/manual_scaling.mduser_guide/features/auto_scaling.md 合并为 docs/zh/design/scaling.md
    • 章节顺序为先自动扩缩容(特性概述、工作原理、指标设计、策略配置、关键设计考虑),后手动扩缩容;
    • 手动扩缩容部分重写为设计思路(集群 ConfigMap 基线机制、单一变更维度约束、增量式调整、部署模式自适应、成功即刷新基线、前置校验),删除原文档中的代码级实现细节(具体函数名、报错文案、YAML 生成逻辑)。
  3. 清理与链接同步:删除两份旧文件,更新 user_guide/features/fault_tolerance/standby.md 中指向设计文档的链接。
  4. 导航同步:同步更新 docs/zh/.nav.yaml(docs 站点导航,由 mkdocs awesome-nav 加载,不更新则文档网页 404):
    • 「主备倒换」设计文档条目:design/standby.mddesign/fault_tolerance/standby.md
    • 「手动扩缩容」设计条目(原文件已删除):→ design/scaling.md,条目名改「扩缩容」;
    • 删除特性指南中已移走的 user_guide/features/auto_scaling.md 条目;
    • 顺带修复 2 处历史断链:release_note.md / communication_matrix.md 实际文件名带 _motor 后缀(release_note_motor.md / communication_matrix_motor.md)。

纯文档变更,无代码改动。

likedislike
Pull Request已成功合入, 合并人@tobking
(感谢 jason lyu 的贡献)
jason lyujason lyu成员
8月6日 关联了issue:[Documentation|文档反馈]: 设计文档优化:扩缩容文档合一为 scaling.md、主备倒换设计文档归位
atomgit-bot
atomgit-bot
8月6日 评论:

变更摘要

本次变更纯为文档重组与优化,无代码改动。主要将主备倒换设计文档 standby.md 归入容错设计文档子目录,并将手动扩缩容与自动扩缩容两份文档合并为统一的 scaling.md 设计文档,同时清理旧文件并更新交叉引用链接。

主要改动

  • 主备倒换文档归位:将 docs/zh/design/standby.md 移至 docs/zh/design/fault_tolerance/standby.md,与 fault_managerprecision_detection 等容错设计文档归入同一目录,并修正文档内图片相对路径(../imgs/../../imgs/)。
  • 扩缩容文档合一:将 design/manual_scaling.mduser_guide/features/auto_scaling.md 合并为 docs/zh/design/scaling.md,章节按先自动扩缩容后手动扩缩容排列;手动扩缩容部分重写为设计思路描述(集群 ConfigMap 基线机制、单一变更维度约束、增量式调整、部署模式自适应、成功即刷新基线、前置校验),删除原有代码级实现细节。
  • 旧文件清理:删除 design/manual_scaling.mduser_guide/features/auto_scaling.md 两份已合并的旧文件。
  • 链接同步更新:修正 user_guide/features/fault_tolerance/standby.md 中指向设计文档的链接,确保指向新路径。
likedislike
atomgit-bot
atomgit-bot
8月6日 评论:

代码审查

✅ 未发现问题

likedislike
ascend-robotascend-robot成员
8月6日 添加了label:stat/needs-squash
ascend-robotascend-robot成员
8月6日 添加了label:ascend-cla/yes
此处折叠了94条消息 查看更多
yuzechen
yuzechen成员
24 天前 评论:

/lgtm

likedislike
ganglv成员
24 天前 评论:

/approve

likedislike
ascend-robotascend-robot成员
24 天前 添加了label:approvedlgtm
tobkingtobking成员
24 天前 关闭了关联的issue
tobkingtobking成员
24 天前 合入了pull request