DocImpact¶
当添加影响文档的代码时（例如，添加新参数），开发者会添加 DocImpact 标记。
在提交消息中使用 DocImpact 标记¶
在任何 OpenStack 项目中，您可以在提交消息中添加 DocImpact 标记，以帮助识别需要在 OpenStack 手册项目编写文档的任何错误。
这种方法提供了对补丁可能对文档产生影响的通知和跟踪。如果您的提交对文档有影响，例如添加、更改或删除命令行选项、弃用或新功能、注意事项，或者您在补丁中编写了文档，请将“DocImpact”添加到提交消息中的一行。
这将在 gerrit/projects.yaml 文件中指示的项目中创建 Launchpad 错误，该文件位于 openstack/project-config 仓库中。这不能保证会编写文档，但提供了对更改的可视性和跟踪。您也可以将其用作提醒，以便以后为该功能编写文档，或者提醒您找到可以为您编写文档的作者。
如果您是文档贡献者，当收到 DocImpact 通知时，我们将采取以下步骤。
在
openstack-manuals或openstack-api-site中创建一个新的文档错误。在错误中在标题中，根据补丁影响的版本，放入
newton或ocata。将
review.opendev.org链接复制并粘贴到错误描述中。如果代码补丁登陆，在错误描述中描述受影响的文档。
在代码补丁合并之前，将文档错误设置为
New。
继续检查补丁，并在合并后将状态更改为
Confirmed。使用 文档错误分级指南 部分中的信息，在登陆后设置优先级。
编写良好的 DocImpact 提交消息¶
由于整个提交消息都包含在记录的错误中，请尝试在提交消息中包含尽可能多的信息，关于哪些文档受众受到更改或增强的影响，更改是什么以及为什么它很重要。在编写提交消息时，请回答以下问题
谁会使用该功能？
为什么要使用该功能？
该功能的具体用法是什么？如果这是一个 API 更改，请提供示例请求和响应。
该功能是否还附带权限/策略？如果是，要求是什么？
如果这是一个配置选项更改，我们的自动化将自动检测到它。但是，我们要求在自动化生成之外，单独提交错误。
如果这是一个 CLI 更改，我们也有自动化可以检测到帮助文本，但额外的用法信息很有用。
第三方 DocImpact 设置¶
默认情况下，DocImpact 标记使用仓库名称作为 Launchpad 中的项目创建错误。要更改此行为，可以使用 projects.yaml 中的 docimpact-group 选项。例如，如果您像这样设置项目
- project: stackforge/project-name
description: Latest and greatest cloud stuff.
upstream: git://github.com/awesumsauce/project-name.git
docimpact-group: Project
