문서 리뷰 앱

GitLab 팀 구성원이 문서 변경 사항이 포함된 머지 리퀘스트에 대해 리뷰 앱을 배포하고 미리 보는 방법을 설명합니다.

GitLab 팀 구성원은 문서 변경 사항이 포함된 머지 리퀘스트에 대해 리뷰 앱 을 배포할 수 있습니다. 리뷰 앱을 통해 머지 전에 변경 사항이 GitLab Docs 사이트 에서 어떻게 표시되는지 미리 확인할 수 있습니다. 리뷰 앱 배포는 다음 프로젝트에서 사용할 수 있습니다: 프로젝트 구성 파일 GitLab .gitlab/ci/docs.gitlab-ci.yml Omnibus GitLab gitlab-ci-config/gitlab-com.yml GitLab Runner .gitlab/ci/docs.gitlab-ci.yml GitLab Charts .gitlab/ci/review-docs.yml GitLab Operator .gitlab-ci.yml 리뷰 앱 배포 # 머지 리퀘스트에서 review-docs-deploy job을 수동으로 트리거하여 리뷰 앱을 배포할 수 있습니다. 이 job은 docs-gitlab-com 프로젝트의 Hugo 정적 사이트 생성을 사용하여 문서 변경 사항을 미리 보기로 만듭니다. 사전 요구 사항: 프로젝트에 대한 Developer 권한이 있어야 합니다. 외부 기여자는 이 job을 실행할 수 없습니다. 외부 기여자인 경우 GitLab 팀 구성원에게 대신 실행을 요청하세요. 리뷰 앱을 배포하려면: 머지 리퀘스트에서 review-docs-deploy job을 수동으로 실행 하세요. 이 job은 변경 사항을 포함한 문서 사이트를 빌드하고 배포하는 멀티 프로젝트 파이프라인 을 트리거합니다. 파이프라인이 완료되면 View app 을 선택하여 브라우저에서 리뷰 앱을 엽니다. review-docs-cleanup job은 머지 시 자동으로 트리거됩니다. 이 job은 리뷰 앱을 삭제합니다. 문서 리뷰 앱의 동작 방식 # 문서 리뷰 앱은 다음 프로세스를 따릅니다: 머지 리퀘스트에서 review-docs-deploy job을 수동으로 실행합니다. 이 job은 ( gitlab 프로젝트 외부인 경우) scripts/trigger-build.rb 스크립트를 다운로드하고 docs deploy 플래그와 함께 실행합니다. 이 스크립트는 gitlab-org/technical-writing/docs-gitlab-com 프로젝트에서 파이프라인을 트리거합니다. DOCS_BRANCH 환경 변수는 gitlab-org/technical-writing/docs-gitlab-com 프로젝트의 어떤 브랜치를 사용할지 결정합니다. 설정되지 않은 경우 main 브랜치가 사용됩니다. 문서 미리 보기 사이트가 빌드된 후 다른 리뷰 앱과 병렬로 배포 됩니다. 문제 해결 # 리뷰 앱을 사용할 때 다음과 같은 문제가 발생할 수 있습니다. 오류: 문서 리뷰 앱 배포 job에서 401 Unauthorized # 리뷰 앱 배포 job에서 다음과 같은 오류가 발생할 수 있습니다: Server responded with code 401, message: 401 Unauthorized. 이 문제는 DOCS_HUGO_PROJECT_API_TOKEN 이 다음 중 하나에 해당할 때 발생합니