문서 및 UI 링크 테스트

테스트를 위해:

  • 다른 문서로 연결되는 문서에 대한 문서 링크는 Lychee 및 때로는 nanoc을 사용합니다.
  • GitLab UI에서 문서로 연결하는 링크는 haml-lint 및 eslint를 사용합니다.

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

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

  • 문서가 포함된 단일 프로젝트에 대한 링크 확인 실행
  • GitLab 문서 사이트의 로컬 복사본 전체에서 링크 확인 실행

단일 프로젝트 확인

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

  1. Lychee를 설치합니다.
  2. 프로젝트의 루트 디렉토리로 변경합니다.
  3. lychee --offline --include-fragments <doc_directory>를 실행합니다. 여기서 <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 사이트를 빌드하고 nanoc를 사용하여 구축된 사이트의 링크를 확인합니다.

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

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

haml-lint 테스트 실행

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

  2. 다음을 실행합니다: 

    bundle exec haml-lint -i DocumentationLinks

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

    모든 종속 항목을 설치하고 링크를 테스트하려는 경우:

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

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

    gem install haml_lint

  5. 다음을 실행합니다: 

    haml-lint -i DocumentationLinks

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

eslint 테스트 실행

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

  2. 다음을 실행합니다: 

    scripts/frontend/lint_docs_links.mjs

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