团队和仓库标签¶

OpenStack 文档规范¶

这个 git 仓库用于存放 OpenStack 文档计划的已批准设计规范。规范的评审在 gerrit 中进行，使用与我们评审和合并文档及支持工具变更相似的工作流程。

这个仓库的布局是

specs/<release>/

您可以在 doc/source/specs/template.rst 中找到一个示例规范。请用文档蓝图的详细信息填充它。

对于文档，较大的、协调的项目需要蓝图，但小的修复不需要。是否需要规范取决于您的判断，请随时在 #openstack-doc IRC 频道或 openstack-docs 邮件列表中提问。

要为特定版本的文档（如安装指南或配置参考）提出规范，请将新文件添加到 specs/<release> 目录并提交以供评审。可以通过查看 Launchpad 中的蓝图（规范链接到 Launchpad）来查找给定版本的蓝图实施状态。

请注意，并非所有已批准的蓝图都会完全实现。

在 Juno 开发周期之前，此仓库未用于规范评审。Juno 之前的评审完全通过 Launchpad 蓝图完成。

请注意，Launchpad 蓝图仍然用于跟踪蓝图的当前状态。有关更多信息，请参阅 https://wiki.openstack.org/wiki/Blueprints。

有关使用 gerrit 的更多信息，请参阅 https://docs.openstack.org/infra/manual/developers.html#development-workflow。

为了验证规范在语法上是否正确（即，获得对 Zuul 结果的更多信心），请执行以下命令

$ tox

运行 tox 后，文档将以 HTML 格式在 doc/build/ 目录中提供以供查看。请不要将生成的 HTML 文件作为您提交的一部分签入。

文件发布在 https://specs.openstack.org/openstack/docs-specs。

git 仓库位于 https://git.openstack.org/cgit/openstack/docs-specs/。