配置参考:RST 转换

配置参考:RST 转换

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

将配置参考从 DocBook 转换为 RST。

问题描述

配置参考将在 Mitaka 版本中从 DocBook 转换为 RST。生成配置选项表的工具将被修改为生成 RST 表格,而不是 docbook 表格。

提议的变更

将配置参考转换为 RST。

更新 autohelp.pydiff_branches.pyextract_swift_flags.py 脚本,以生成配置选项表。

备选方案

实现

负责人

主要负责人

  • gpocentek

工作项

  • 更新 openstack-doc-tools 脚本以支持 RST 输出。
  • 将内容从 DocBook 转换为 RST。
  • 确保在转换过程中将错误修复提案包含在 DocBook 和 RST 中。
  • wiki 中跟踪更改。
  • 更新我们的构建基础设施,以便使用 Sphinx 发布配置参考。
  • 将 openstackdocstheme 模板应用于该指南。
  • 将翻译从旧指南导入到新指南。

依赖项

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

测试

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

参考资料

  • 讨论可以通过任何官方渠道进行,包括 #openstack-doc IRC 频道、主题中带有 [config-ref] 的 openstack-docs 邮件列表、每周 文档团队会议,以及可能的 etherpads。
Creative Commons Attribution 3.0 License

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

docs-specs