移除 DocBook XML 支持

移除 DocBook XML 支持

https://blueprints.launchpad.net/openstack-manuals/+spec/docbook-removal

随着 Newton 周期完成最后一次转换为 RST,我们可以简化我们的工具,使其仅处理 RST,从而移除 DocBook XML 支持。

问题描述

该工具支持 DocBook XML,但 Newton 版本不需要它。

目前该工具用于构建和发布 DocBook XML 用于

  • trove 仓库。
  • api-site 仓库。
  • openstack-manuals 仓库的 kilo 和 liberty 稳定分支。
  • operations-guide 仓库。

operations-guide 仓库有一个指南几乎完成了 RST 转换。api-site 仓库包含 API 参考,目前正在转换为 RST。trove 仓库的工作尚未开始。

此外,clouddocs-maven-plugin 用于发布 DocBook XML 手册。它也在 heat、senlin 和 zaqar 仓库中使用,用于根本不发布的文档。

提议的变更

简化所有工具,使其仅处理 RST,移除对 DocBook XML 的支持。

冻结 clouddocs-maven-plugin,我们将不会为其添加任何新功能,并在项目不再将其用于文档发布时退役该仓库。

备选方案

  • 保持现状。

实现

负责人

主要负责人
jaegerandi (Andreas Jaeger)

工作项

  • 与 trove 团队讨论移除事宜。
  • 通知 heat、senlin、zaqar 团队移除事宜。
  • 对于需要 XML 发布功能的仓库:将 openstack-doc-tools 版本固定到 0.34,因为那是最后一个支持 XML 的版本。
  • 将术语表转换为 RST 并移除 openstack-manuals 仓库中的 XML 发布功能。
  • 从 openstack-doc-tools 中移除 DocBook XML 发布功能。
  • 从 openstack-doc-tools 中移除 DocBook 翻译处理功能。
  • 更新贡献者指南以反映此更改。
  • 更新 openstack-doc-tools 中的文档以反映此更改。

依赖项

  • 发布 OPS 指南的 RST 版本。

测试

  • 将手动进行工具测试,并作为构建的一部分进行。我们应该添加一些方法来进行集成测试。
Creative Commons Attribution 3.0 License

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

docs-specs