문서 워크플로우

GitLab의 문서는 워크플로우를 따릅니다.

합병하기 전에

문서에 다음이 포함되었는지 확인하세요:

스타일 가이드와 용어 디렉터리을 준수했는지 확인하세요.

문서 레이블

이슈나 Merge Request을 작성할 때, 문서 템플릿을 선택하세요. 이에는 다음과 같은 레이블이 포함됩니다.

기술 문서 작성팀 구성원은 다음과 같은 레이블을 추가합니다:

note
/doc/development/documentation 이외의 경로의 콘텐츠는 기술 작성자가 검토하지 않습니다. 모든 Maintainer는 /doc/development 디렉터리에 있는 내용을 Merge할 수 있습니다. 만일 /doc/development 디렉터리에 있는 콘텐츠에 대해 기술 작성자의 검토를 받고 싶다면, #docs Slack 채널에서 문의하세요.

Merge 후 리뷰

Merge 전 기술 작성자에게 할당되지 않았다면, 개발자나 Maintainer가 즉시 Merge 후 리뷰 일정을 잡아야 합니다. 이를 위해 문서 리뷰 설명 템플릿을 사용하여 이슈를 생성하고, 문서 변경 사항을 도입한 Merge Request에서 해당 이슈에 대한 링크를 제공하세요.

정기적인 Merge 전 기술 작성자 리뷰를 건너뛸 수 있는 경우:

  • 마일스톤 릴리스 직전에 남은 시간이 적은 경우. 3일보다 적은 시간이 남았다면, Merge 후 리뷰를 요청하고 리뷰가 가능한 빨리 완료되도록 Slack을 통해 작성자에게 알립니다.
  • 변경 사항이 작고, 해당 기능(예: GitLab.com 사용자)의 초기 사용자가 문서를 쉽게 사용할 수 있다는 높은 확신이 있는 경우.

기억하세요:

  • GitLab에서는 문서를 코드와 같이 처리합니다. 코드와 마찬가지로, 문서는 품질을 보장하기 위해 검토되어야 합니다.
  • 문서는 GitLab의 완료 정의의 일부입니다.
  • Merge 전 기술 작성자 리뷰는 마일스톤 릴리스보다 훨씬 앞서 코드가 완료됐을 때나 큰 문서 변경 사항에 대해 가장 흔히 요청됩니다.
  • 가능한 빨리 표시된 코드와 함께 Merge되어야 하는 문서에 대해 Merge 후 기술 작성자 리뷰를 요청할 수 있습니다. 이 경우, 원본 MR의 작성자가 기술 작성자가 제공한 피드백에 대응할 수 있도록 후속 MR에서 해당 작업을 수행할 수 있습니다.
  • 기술 작성자는 Merge 전 기술 작성자 리뷰를 요청하지 않아도 될 때 문서를 Merge할 수 있는지 결정하는 데 도움을 줄 수 있습니다. 이 경우, 기술 작성자가 제공한 피드백에 대해 처음 Merge된 MR의 작성자가 후속 MR에서 해당 작업을 수행할 수 있습니다.

기술 작성자 리뷰가 필요 없는 페이지

/doc/solutions 하위의 문서는 솔루션 아키텍트 팀이 작성, 유지 관리, 복사 편집, Merge합니다.

AI 생성 콘텐츠

GitLab 문서에 AI 생성 콘텐츠를 기여할 수 있으며, 이 경우 DCO 또는 CLA 조건에 따라야 합니다.

관련 주제