治理标签文档指南

重要提示

自 Pike 版本发布以来，这些指南已过时，不再涵盖新的文档范围。

修订版即将发布。

`docs:follows-policy` 标签表明 OpenStack 文档团队以及与标记交付物相关的项目团队已验证在 openstack-manuals 仓库中的项目文档准确且最新。

定义

此标签表明交付物的文档集是与 OpenStack 文档团队协调准备的，遵循他们定义的审查和验证实践和策略。它并不表明文档团队已承担为交付物生成文档的所有权。

为了维护 `docs:follows-policy` 标签，文档跨项目联络人 (CPL) 或项目技术负责人 (PTL) 必须阅读与其项目相关的文档，并提交任何适当的 错误报告，向文档团队提供有关如何记录这些问题的相关信息。

有关详细信息，请参阅 docs:follows-policy。

指南

文档审查截止日期与功能冻结时间一致。请参阅 OpenStack 发布计划。

发布前 6 周

联络人已告知文档团队所有主要的新功能和错误修复，直到目前为止。

项目团队要么

• 通过 错误报告 向文档团队提供足够的信息，以确保正确记录该错误或增强功能

或者

• 向 openstack-manuals 仓库提供修复。如果提交补丁，则此类问题在批准前需要相关项目团队的额外 +1 确认。

发布前 4 周

项目团队确保联络人已审查团队项目的文档，并且

• 通过 错误报告 向文档团队提供足够的信息，以确保正确记录该错误或增强功能

或者

• 向 openstack-manuals 仓库提供修复。如果提交补丁，则此类问题在批准前需要相关项目团队的额外 +1 确认。

发布前 2 周

CPL 与文档发布团队合作测试安装说明并完成发布测试矩阵（例如，请参阅 Ocata 发布测试矩阵）。建议联络人至少在一个发行版上测试这些说明。