又到了新的一年，是时候反思并寻找改进 OpenStack 文档的方法。以下是 2013 年 OpenStack 文档领域的主要事件。让我们回顾一下这一年。
- 操作指南书冲刺活动于 2013 年 2 月举行，我仍然记忆犹新。 之前的帖子 和 之后的帖子 讲述了这段故事，就像 这个视频 一样。
- Diane Fleming 在不断增长的 API 参考网站 http://api.openstack.org/api-ref.html 上添加了一个侧边栏，用于导航。我希望看到该页面设计有更多改进，以适应不同的设备，提高响应速度。
- 我们改进了 DocImpact 提交消息标志，开发者可以在提交消息中添加 DocImpact，并在后台自动触发一些自动化流程，自动记录一个文档缺陷，将其设置为“新建”状态，直到补丁实际合并，从而减少了大量手动步骤。感谢 Tom Fifield 和 Steven Deaton 在 2013 年的这项成就。
- 我们还能够在秋季的 Havana 版本的发布时，首次同时发布文档和代码。这项成就很大程度上归功于 配置参考 的自动化，其中自动文档工具会抓取文档字符串并将它们收集到每个功能和每个项目的有意义的表格中。
- 今年包括对 docs.openstack.org 网站首页的彻底重组。我们还添加了新的标题，以适应新的受众。我们有新的用户指南和管理员用户指南，它们将指导用户完成仪表板和命令行界面程序，以完成诸如启动实例之类的常见任务。如上所述，我们还在维护一个新的配置参考，其中列出了跨多个 OpenStack 项目的所有可能的配置选项。
- 在波特兰峰会上之后，我与 Cisco 的 Lew Tucker 精心组织的团队合作，聘请了一名专门负责上游的 OpenStack 安装指南的合同作者。尽管有专门的资源，仍然存在一些问题和延误，但最终的安装指南受到了好评。
- 我们在阳光明媚的加利福尼亚州 Mirantis 办公室举办了一次中期发布的 OpenStack 文档训练营。我们互相学习，并认识了以前从未见过面的贡献者。
- 2013 年 7 月，OpenStack 安全团队在马里兰州一个未公开地点组织了一次出色的 OpenStack 安全指南 书冲刺活动，并配有 书冲刺。至少我认为它就在那里。他们非常注重安全。
- 在 Emilien Macchi 和 Enovance 测试实验室的帮助下，高可用性指南 也得到了更新。
- 我们的工具链现在支持日语字体，日语翻译现在可以在 docs.openstack.org/ja/ 上找到。非常感谢翻译团队，特别是日语团队负责人 Masanori Itoh、I18N 团队负责人 Daisy Guo 和 David Cramer，他们为字体支持提供了文档工具。
- 同样在 2013 年，我们还在 OpenStack 文档程序中孵化了开源培训手册团队。他们制作了一份 Associate 培训指南，其中包含 Operator 培训指南、Developer 培训指南和 Architect 培训指南的提纲和时间表。所有指南和提纲都可以在 https://docs.openstack.org/training-guides/content/ 上找到。
- 在香港峰会上，我们宣布 OpenStack 操作指南成为 O’Reilly 版本，并且我们正在处理来自开发编辑的反馈意见。
- 最近，我们在 12 月 20 日举行了一次文档缺陷日，修复了 80 多个缺陷，从澳大利亚到美国西海岸，然后又继续前进。
过去一年，OpenStack 文档成为一个官方程序，我 Anne Gentle 当选为程序技术负责人。我希望继续服务并推广文档工作，进入新的一年。是的，我阅读了用户调查的反馈，我知道我们还有很多工作要做。但在 2013 年，文档成为第二大被抱怨的问题，而不是第一大被抱怨的问题，这是一个值得庆祝的时刻。感谢众多贡献者们促成这些增量改进。
发表评论