迁移到新网页设计¶

备选方案¶

与其为新设计使用 RST/Sphinx，不如迁移到 markdown/Jekyll，这正是原型设计已在使用的。OpenStack 生态系统目前支持像 Sphinx 这样的 Python 系统，并且 oslosphinx 已经有一个可用的主题。

我们可以彻底淘汰所有书籍的 DocBook，而不是采用分阶段的方法。我认为在六个月的发布周期内我们没有时间做到这一点，所以我提议采用分阶段的方法。

负责人¶

主要负责人

annegentle

其他贡献者

jagerandi loquacities klevenstein dhellman

工作项¶

研究

2015 年 1 月 - 调查如何在新的设计中发布 PDF 文件。- 调查使用跨存储库的 index.rst 集合进行新的可交付成果组装。这不是迁移的必需任务，但肯定有助于信息架构朝着“每个页面都是第一页”而非书籍式的可交付成果发展。（jaegerandi）

框架

1 月：为约定维基页面创建建议标签的分类法（klevenstein, loquacities）

完成 2015 年 1 月 15 日：从 Jekyll 设计创建 jinja2 模板用于

• 登录页和搜索（fifieldt）

完成 2015 年 2 月 20 日：从 Jekyll 设计创建 Sphinx 模板用于

• 内容页面（annegentle）

完成 2 月：用新设计替换 openstack-manuals 中的静态 www jinja 模板

内容概念验证

2015 年 2 月 15 日：按此优先级顺序将这些书籍从 DocBook 迁移到 RST

• 最终用户指南
• 管理员用户指南

维基页面跟踪：https://wiki.openstack.org/wiki/Documentation/Migrate

2015 年 2 月 28 日：更新我们的构建基础设施，以便使用 Sphinx 发布这些文档

• 最终用户指南
• 管理员用户指南

2015 年 2 月 20 日：跨浏览器测试模板，确保与设计一致

• Ubuntu、Fedora、Mac、Windows 上的 Chrome
• Ubuntu、Fedora、Mac、Windows 上的 Firefox

2015 年 3 月：测试翻译工具链。郭映春（Daisy）已同意进行调查。

完成 2015 年 2 月 15 日：更新 oslosphinx 以拥有新的 openstackdocs 主题：目前主题名称是“openstack”。与 Doug Hellman 审查计划后，我们可以保留 openstack 主题并创建一个名为“openstackdocs”的主题，或者将 openstack 主题更新为新设计。我更倾向于命名一个新的“openstackdocs”，以便当前的 openstack 主题可以指示项目文档何时处于孵化状态。

已完成更新：查看头部的所有信息架构，似乎最好有一个不一定存在于 oslosphinx 中的 openstack docs 主题。例如，Oslosphinx 用于 https://specs.openstack.org、https://docs.openstack.org/infra/system-config、http://governance.openstack.org，而 https://docs.openstack.org/infra/system-config 已修改了头部，因此它不会与其他站点匹配。因此，计划是将 oslosphinx 主题保留在 oslosphinx 中，并在一个单独的存储库中创建一个名为 openstackdocsthemes 的主题，用于应用于发布到 https://docs.openstack.org 的所有内容。

3 月（概念验证和持续集成完成后）：按此优先级顺序将这些书籍从 DocBook 迁移到 RST

• 云管理员指南
• 虚拟机镜像指南
• 高可用性指南
• API 快速入门指南

3 月：迁移后，将新的 openstackdocstheme 模板应用于这些存储库和可交付成果

openstack-manuals

• 最终用户指南
• 管理员用户指南
• 云管理员指南
• 虚拟机镜像指南

api-site

• API 快速入门指南

ha-guide

• 高可用性指南

3 月：提醒项目更新 /developer/ 文档的主题，涉及

• nova
• neutron
• glance
• keystone
• ceilometer
• cinder
• heat
• horizon
• ironic
• sahara
• swift
• trove