文档审查流程
Istio 文档工作组 (WG) 的维护人员和工作组负责人批准对 Istio 网站 的所有更改。
**文档审查者** 是值得信赖的贡献者，他们批准符合 审查标准 中描述的验收标准的内容。所有内容审查均遵循 审查内容 PR 中描述的流程。
只有文档维护人员和 WG 负责人可以将内容合并到 istio.io 存储库 中。
Istio 的内容通常需要在短时间内进行审查，并且并非所有内容都具有相同的相关性。贡献的最后一分钟性质和有限数量的审阅者使得内容审查的优先级成为大规模运作的必要条件。此页面提供了清晰的审查标准，以确保所有审查工作都以**一致**、**可靠**的方式进行，并遵循**相同的质量标准**。
审查内容 PR
文档审阅者、维护者和工作组负责人遵循一个明确的过程来审查内容 PR，以确保所有审查都保持一致。该过程如下所示：
- **贡献者**向 istio.io 存储库提交新的内容 PR。
- **审阅者**对内容进行审查，并确定其是否符合验收标准。
- 如果贡献者尚未添加，**审阅者**会添加与内容相关的任何技术工作组。
- **贡献者**和**审阅者**共同努力，直到内容满足所有必需的验收标准并解决所有问题。
- 如果内容紧急，并且满足补充验收标准需要大量工作，**审阅者**将在 istio.io 存储库中提交后续问题，以便稍后解决这些问题。
- **贡献者**根据审阅者和贡献者之间的约定解决所有必需和补充反馈。后续问题中提交的任何反馈将在稍后解决。
- 当**技术**工作组负责人或维护者批准内容 PR 时，**审阅者**可以批准该 PR。
- 如果文档工作组维护者或负责人审查了内容，他们不仅会批准，还会合并内容。否则，维护者和负责人会自动收到**审阅者**批准的通知，并优先批准和合并已审查的内容。
下图描述了此过程：
- **贡献者**执行灰色形状中的步骤。
- **审阅者**执行蓝色形状中的步骤。
- **文档维护者和工作组负责人**执行绿色形状中的步骤。
跟进问题
当**审阅者**作为审查流程的一部分提交后续问题时，GitHub 问题必须包含以下信息：
- 有关内容未满足的补充验收标准的详细信息。
- 原始 PR 的链接。
- 技术主题专家 (SME) 的用户名。
- 用于对问题进行分类的标签。
- 工作量估算：审阅者提供他们对与原始贡献者一起解决剩余问题需要多长时间的最佳估算。
审查标准
我们的审查流程通过使审查标准透明并将其应用于所有内容贡献，从而支持我们的行为准则。
标准有两个层级：必需和补充。
必填验收标准
- 技术准确性：至少一位技术工作组负责人或维护者审查并批准内容。
- 正确的标记：所有 lint 检查和测试都通过。
- 语言：内容必须清晰易懂。要了解更多信息，请参阅 Google 开发者风格指南的要点和一般原则。
- 链接和导航：内容没有断开的链接，并且站点构建正常。
补充验收标准
- 内容结构：信息结构增强了读者的体验。
- 一致性：内容遵循Istio 贡献指南中的所有建议。
- 样式：内容遵循Google 开发者风格指南。
- 图形资产：图表遵循 Istio图表创建指南。
- 代码示例：内容提供相关、可测试且有效的代码示例。
- 内容重用：任何可重复的内容都遵循使用样板文本的重用策略。
- 术语表：新的术语会添加到术语表中，并附有清晰的定义。