文档审查应用

GitLab 团队成员可以为包含文档更改的合并请求部署一个审查应用。该审查应用允许您在合并前预览您的更改在 GitLab Docs 网站上的显示效果。

审查应用部署适用于以下项目：

部署审查应用

您可以通过在合并请求中手动触发 review-docs-deploy 作业来部署审查应用。

该作业使用来自 docs-gitlab-com 项目的 Hugo 静态站点生成器来创建您的文档更改预览。

先决条件：

• 您必须拥有该项目的 Developer 角色。

外部贡献者无法运行此作业。如果您是外部贡献者，请让 GitLab 团队成员为您运行。

要部署审查应用：

1. 从您的合并请求中，手动运行 review-docs-deploy 作业。 该作业会触发一个多项目流水线，用于构建和部署包含您更改的文档站点。
2. 当流水线完成后，选择 查看应用 在浏览器中打开审查应用。

review-docs-cleanup 作业在合并时自动触发。该作业会删除审查应用。

文档审查应用的工作原理

文档审查应用遵循以下流程：

1. 您在合并请求中手动运行 review-docs-deploy 作业。

2. 该作业下载（如果在 gitlab 项目外）并运行带有 docs deploy 标志的 scripts/trigger-build.rb 脚本，该脚本会在 gitlab-org/technical-writing/docs-gitlab-com 项目中触发一个流水线。

   DOCS_BRANCH 环境变量决定使用 gitlab-org/technical-writing/docs-gitlab-com 项目的哪个分支。如果未设置，则使用 main 分支。

3. 文档预览站点构建完成后，会与其他审查应用并行部署。

故障排除

使用审查应用时，您可能会遇到以下问题。

错误：文档审查应用部署作业中出现 401 Unauthorized

您可能会在审查应用部署作业中收到如下错误：

Server responded with code 401, message: 401 Unauthorized.

当 DOCS_HUGO_PROJECT_API_TOKEN 出现以下情况时，会发生此问题：

• 已过期或已被撤销，需要重新生成。
• 已重新创建，但使用它的项目中的 CI/CD 变量未更新。

这些情况会导致文档审查应用的部署作业无法查询下游项目的下游流水线状态。

要解决此问题，请联系 技术写作团队。有关文档审查应用令牌的更多信息，请参阅 GitLab 文档站点维护。