문서 및 UI 링크 테스트

테스트용으로:

  • 다른 문서에 대한 문서 링크는 Lychee를 사용하고 때때로 nanoc를 사용합니다.

  • GitLab UI에서 문서로의 링크는 haml-lint와 eslint를 사용합니다.

로컬에서 문서 링크 테스트 실행

로컬에서 문서 링크 테스트를 실행하려면 다음 중 하나를 선택할 수 있습니다:

  • 문서를 포함하는 단일 프로젝트에 대한 링크 체크를 실행합니다.
  • GitLab 문서 사이트의 전체 로컬 복사본에 대한 링크 체크를 실행합니다.

단일 프로젝트 체크

단일 프로젝트의 링크를 확인하려면:

  1. Lychee를 설치합니다.

  2. 프로젝트의 루트 디렉토리로 이동합니다.

  3. <doc_directory>가 문서를 포함하는 디렉토리인 lychee --offline --include-fragments <doc_directory>를 실행합니다. 예: lychee --offline --include-fragments doc.

모든 GitLab Docs 사이트 프로젝트 체크

전체 GitLab 문서 사이트의 링크를 확인하려면:

  1. gitlab-docs 클론과 동일한 디렉토리에 모든 문서 프로젝트가 클론되어 있는지 확인합니다. make clone-all-docs-projects를 실행하여 해당 위치에 없는 프로젝트를 클론할 수 있습니다. 문서 프로젝트를 업데이트하려면 make update-all-projects를 실행합니다.

  2. gitlab-docs 디렉토리로 이동합니다.

  3. make internal-links-and-anchors-check를 실행하여 nanoc로 GitLab Docs 사이트를 빌드하고 빌드된 사이트의 링크를 체크합니다.

로컬에서 UI 링크 테스트 실행

GitLab UI에서 문서 링크를 로컬로 테스트하려면 haml-lint와 eslint를 모두 실행해야 합니다.

haml-lint 테스트 실행

  1. 터미널 창에서 gitlab 디렉토리를 엽니다.

  2. 다음을 실행합니다:

    bundle exec haml-lint -i DocumentationLinks

이 테스트를 처음 실행할 때 오류가 발생하면 bundle install을 실행하여 GitLab의 종속성을 설치하고 다시 시도합니다.

링크를 테스트하기 위해 모든 종속성을 설치하고 싶지 않다면:

  1. 터미널 창에서 gitlab 디렉토리를 엽니다.

  2. haml-lint를 설치합니다:

    gem install haml_lint

  3. 다음을 실행합니다:

    haml-lint -i DocumentationLinks

이 프로세스로 haml-lint를 수동으로 설치하면 자동으로 업데이트되지 않으며 GitLab에서 사용되는 버전과 일치하는지 확인해야 합니다.

eslint 테스트 실행

  1. 터미널 창에서 gitlab 디렉토리를 엽니다.

  2. 다음을 실행합니다:

    scripts/frontend/lint_docs_links.mjs

이 테스트를 처음 실행할 때 오류가 발생하면 yarn install을 실행하여 GitLab의 종속성을 설치하고 다시 시도합니다.