文档和 UI 链接测试

用于测试：

• 文档文件之间的相对链接，我们使用 Lychee。
• 从 GitLab UI 链接到文档，我们使用 haml-lint, eslint, 和 rubocop。

在本地运行相对链接测试

要在本地运行相对链接测试，您可以：

• 对包含文档的单个项目运行链接检查。
• 对 GitLab 文档站点 的整个本地副本运行链接检查。

检查单个项目

要检查单个项目中的链接：

1. 安装 Lychee。
2. 进入项目的根目录。
3. 运行 lychee --offline --include-fragments <doc_directory>，其中 <doc_directory> 是包含要检查的文档的目录。例如：lychee --offline --include-fragments doc。

检查所有 GitLab Docs 站点项目

要检查整个 GitLab 文档站点 上的链接：

1. 确保您将所有文档项目克隆在与 docs-gitlab-com 克隆相同的目录中。您可以运行 make clone-docs-projects 来克隆该位置中您没有的项目。
2. 进入 docs-gitlab-com 目录。
3. 运行 hugo，它会构建 GitLab Docs 站点。
4. 运行 lychee --offline public 来检查链接。

在本地运行 UI 链接测试

要在本地测试来自 GitLab 代码文件的文档链接，您可以运行

• eslint：用于前端（.js 和 .vue）文件。
• rubocop：用于 .rb 和 .haml 文件。

运行 eslint 测试

1. 在终端窗口中打开 gitlab 目录。

2. 运行：

   scripts/frontend/lint_docs_links.mjs

如果您第一次运行此测试时收到错误，请运行 yarn install，它会安装 GitLab 的依赖项，然后重试。

运行 rubocop 测试

1. 安装 RuboCop

2. 在终端窗口中打开 gitlab 目录。

3. 要对所有 Ruby 文件进行检查：

   rubocop --only Gitlab/DocumentationLinks/Link

   要对单个 Ruby 文件进行检查：

   rubocop --only Gitlab/DocumentationLinks/Link path/to/ruby/file.rb