文档 openstack-doc-tools 和 openstackdocstheme¶
https://blueprints.launchpad.net/openstack-doc-tools/+spec/document-tools
问题描述¶
关于 openstack-doc-tools 和 openstackdocstheme 的文档目前分散在项目仓库中的各种 README 文件以及 OpenStack 文档贡献者指南 中。在某些情况下，内容存在重复、过时或缺失的情况。
提议的变更¶
在 openstack-doc-tools 和 openstackdocstheme 仓库内创建 Sphinx 文档项目，更新并完善两个仓库的文档，然后将指南发布到 docs.openstack.org/developer/。
从 OpenStack 文档贡献者指南 和仓库 README 文件中添加指向新指南的适当链接。
openstack-doc-tools 仓库已经有一个 Sphinx 文档项目，目前未发布，但可以将其作为指南的基础。
openstackdocstheme 也有一个 Sphinx 文档项目，提供了主题测试的示例内容，应该保留或合并到发布的指南中。
备选方案¶
- 将内容整合到
openstack-manuals仓库中的一个新的 OpenStack 文档工具指南 中。 - 将内容整合到现有的 OpenStack 文档贡献者指南 中。
- 维持现状（不做任何改变）。
实现¶
负责人¶
- 主要负责人
- Brian Moss (bmoss)
- 其他贡献者
- 文档团队
工作项¶
- 在
openstack-doc-tools和openstackdocstheme仓库内创建 Sphinx 文档项目。 - 将现有内容复制到新指南中。
- 将文档检查添加到 tox 环境和 Jenkins gate 中。
- 将新指南发布到 docs.openstack.org/developer/$REPO。
- 用指向新指南内容的链接替换原始位置的内容。
- 编辑内容并添加缺失的材料。
依赖项¶
无
测试¶
测试将遵循标准文档审查流程。
除非另有说明，本文档根据 知识共享署名 3.0 许可协议 授权。请参阅所有 OpenStack 法律文件。