架构设计指南改进

架构设计指南改进

https://blueprints.launchpad.net/openstack-manuals/+spec/arch-guide

审查、编辑和重新组织架构设计指南。

问题描述

架构设计指南自创建以来尚未经过彻底审查。这导致了以下问题:

  • 语言和语法不符合我们的规范
  • 信息架构有待改进
  • 内容重复

提议的变更

  • 重新组织指南以改善现有内容的呈现方式
  • 清理现有内容,并在必要时删除重复内容
  • 识别信息缺口,并在必要时提交 bug

这项工作是未来版本将该指南从 Docbook XML 转换为 RST 的先决条件。

备选方案

  • 保持指南原样
  • 针对需要改进的每个单独部分提交 bug

实现

负责人

主要负责人
Brian Moss (bmoss)
其他贡献者
文档 Swarm 参与者

工作项

预计这项工作的大部分将在即将到来的文档 Swarm 中完成,该 Swarm 将于 8 月 13-14 日在澳大利亚布里斯班举行。请参阅 参考

  • 修改摘要,以明确识别书籍的受众和目的
  • 尽可能减少指南中的重复内容。
  • 编辑以保持一致性并遵守我们的规范
  • 根据需要移动部分,以改进信息架构

依赖项

测试

标准文档审查流程。

Creative Commons Attribution 3.0 License

除非另有说明,本文档根据 知识共享署名 3.0 许可协议 授权。请参阅所有 OpenStack 法律文件

docs-specs