Icehouse 版本用于培训指南

Icehouse 版本用于培训指南

https://blueprints.launchpad.net/openstack-training-guides/+spec/training-icehouse-release

培训指南已准备好发布 Icehouse 内容。根据我们在巴黎 Kilo 设计会议期间的讨论,团队达成共识,将从 XML 书籍过渡到 RST 演示文稿,以便更有效地提供培训内容,并消除内容的重复。

优点

  • 易于从 XML 迁移到 RST。
  • XML 内容仍然可用于当前的培训课程。
  • 将消除手册仓库中的内容重复。
  • 更容易与 OpenStack 的当前发布周期保持同步。
  • 保持发布周期与 OpenStack 发布同步。

注意:Kilo 会议 Etherpad 讨论:https://etherpad.openstack.org/p/training-guides-kilo-summit

问题描述

问题详细描述

  • XML 内容将被存档并删除。
  • 从 XML 书籍格式迁移到 RST 演示文稿格式。
  • 保留现有内容以支持正在进行的培训课程。
  • 仅将当前的 XML 内容发布到 Icehouse 分支。
  • 像 Juno、Kilo 这样的其他版本将使用基于 RST 的幻灯片发布。
  • 未来,Juno、Kilo 分支将根据需要创建,以便为培训指南发布更新的版本。

提议的变更

  • 冻结主分支并将其分支为 Icehouse。
  • 为 XML 内容添加 Icehouse 水印。
  • XML 内容将驻留在 Icehouse 分支的培训指南中。
  • XML 内容将不再处于积极开发状态,主要用于存档目的,以支持使用当前内容进行的持续培训课程。
  • 发布后,主分支将不再包含 XML 内容。
  • 主分支将仅包含 RST 文件。

备选方案

  • 使用 git 历史记录指向给定的 Icehouse 版本,而不是分支。这存在多个问题:- 可能会让培训师(我们的最终用户)感到困惑。- 这只会服务于该项目的开发人员。- 难以发布更新的版本。
  • 将 XML 和 RST 文件并排放置。- 这种替代方案不可取,因为它存在 XML 交叉引用方面的问题,应避免。

实现

负责人

dguitarbite

工作项

  • 冻结培训指南仓库的主分支。
  • 基于当前主分支创建 stable/icehouse 分支。
  • 更新 docs.openstack.org/icehouse/index.html 页面以指向 /icehouse/training-guides/。
  • 更改 stable/icehouse 分支中的 icehouse 分支中的发布过程(pom.xml、tox.ini)。
  • 从 openstack/training-guides 主仓库中删除 XML 内容。
  • 从 docs.openstack.org/training-guides/ 添加重定向到 docs.openstack.org/icehouse/training-guides。
  • 更改主分支中的发布过程,以发布到 docs.openstack.org/trunk/training-guides,其中包括 RST 源代码构建结果。
  • 更新主分支中的 docs.openstack.org/trunk/index.html 页面以链接到 RST 内容的构建结果。

依赖项

无。

测试

Creative Commons Attribution 3.0 License

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

docs-specs