网络指南：实施版本控制¶

问题描述¶

网络指南目前使用持续部署机制进行发布。换句话说，只有主分支存在于 docs.openstack.org 上。在网络指南首次发布后的几个版本中，持续部署出现以下问题：

• 使用诸如“在 Kilo 中…”或“在 Liberty 中…”之类的措辞会令人困惑，并且如果搜索引导至特定功能的特定页面，则很难找到该功能在 OpenStack 的某个版本中可用。例如，一个章节有一个注释，表明 Liberty 版本包含某个特定功能，但章节内的部分缺少关于该功能的注释。
• 维护部署场景很困难，因为功能和配置选项会随着每个版本的变化而变化。例如，Juno 中的 DVR 仅支持 GRE 和 VXLAN 网络，但 Kilo 及更高版本的 DVR 也支持 VLAN 网络。尝试在配置片段中使用“在 Kilo 中…”或“在 Liberty 中…”会使它们越来越令人困惑。

提议的变更¶

与 OpenStack 版本一起发布网络指南的稳定版本。除错误修复外，补丁应用于主分支，并需要额外考虑回溯到先前版本。

网络指南已经存在稳定的发布标签。但是，对于特定版本的网络指南更新通常在该版本发布后发生。例如，Kilo 中部署场景的补丁大多在 Kilo 版本发布几个月后合并。因此，现有的 stable/kilo 标签主要包含适用于 Juno 的内容，而 stable/liberty 标签主要包含适用于 Kilo 的内容。将先前版本的内容对齐需要仔细回溯大量的补丁。

实施此规范后，未来版本的更新应在发布之前发生，类似于安装指南。

实现¶

依赖项¶

无。

测试¶

• 在进入下一阶段并最终实施规范之前，验证正确的发布。

参考资料¶

• 讨论可以使用任何官方媒介进行，包括 #openstack-doc 中的 IRC、openstack-docs 邮件列表、每周 文档团队会议、双周 网络指南子团队会议，以及潜在的 etherpads。