命令行界面参考：RST 转换

更新日期：2018-12-06 13:55

命令行界面参考：RST 转换

https://blueprints.launchpad.net/openstack-manuals/+spec/cli-ref-rst

将命令行界面参考从 DocBook 转换为 ReST。

问题描述

命令行界面参考使用旧的 DocBook 格式。目前，我们使用新的文档主题，格式为 ReST。

提议的变更

将命令行界面参考从 DocBook 转换为 ReST，包括自动化脚本。

备选方案

无

实现

负责人

主要负责人

  • kato-tomoyuki

工作项

  • 停止更新整个指南。
  • 修改命令行参考生成工具的输出，从 DocBook 转换为 ReST。
  • 将手册内容从 DocBook 转换为 Rest。
  • 在 wiki 中跟踪更改。
  • 更新我们的构建基础设施，以便使用 Sphinx 发布命令行界面参考。
  • 将 openstackdocstheme 模板应用于该指南。

依赖项

主要依赖项是 docs.openstack.org 基础设施的更新。

测试

  • 在以下浏览器/操作系统上测试新的 HTML 设计
    • Ubuntu、Fedora、Mac、Windows 上的 Chrome
    • Ubuntu、Fedora、Mac、Windows 上的 Firefox

参考资料

  • 讨论可以通过任何官方渠道进行，包括 #openstack-doc IRC 频道、主题中包含 [cli-ref] 的 openstack-docs 邮件列表、每周 文档团队会议，以及可能的 etherpads。
更新日期：2018-12-06 13:55
Creative Commons Attribution 3.0 License

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

问题？

docs-specs