문서 작업 흐름
GitLab의 문서는 특정한 작업 흐름을 따릅니다.
병합 전
문서에 다음 사항이 포함되었는지 확인하세요:
문서 라벨
이슈나 병합 요청을 작성할 때, 문서 템플릿을 선택하세요. 여기에는 다음과 같은 라벨이 포함됩니다:
-
유형 라벨,
~"type::feature"또는~"type::maintenance". -
단계 라벨과 그룹 라벨.
예를 들어,
~devops::create및~group::source code. -
~documentation전문화 라벨.
기술 문서 작성팀의 구성원은 다음 라벨을 추가합니다:
-
문서 범위 라벨로
docs::접두어가 붙습니다. 예:~docs::improvement. -
~Technical Writing팀 라벨.
참고:
/doc/development/documentation을 제외한 기술 작성자는 doc/development 디렉토리의 내용을 검토하지 않습니다. 유지자는 doc/development 디렉토리의 내용을 병합할 수 있습니다. doc/development 디렉토리의 내용에 대한 기술 작성자 검토가 필요한 경우 #docs Slack 채널에서 문의하세요.
병합 후 리뷰
병합 전 기술 작성자에게 할당되지 않으면 개발자 또는 유지자가 즉시 병합 후 리뷰를 예약해야 합니다. 이를 위해 문서 리뷰 설명 템플릿을 사용하여 문서 변경 사항을 도입한 병합 요청에서 해당 이슈를 만들고 링크를 걸어야 합니다.
일반적인 병합 전 기술 작성자 리뷰를 건너뛸 수 있는 경우:
- 마일스톤 릴리스 전에 남은 시간이 적은 경우. 3일 미만으로 남았다면 병합 후 리뷰를 요청하고 리뷰가 가능한 즉시 작성자에게 슬랙을 통해 알려야 합니다.
- 변경량이 적고 해당 기능의 초기 사용자(예: GitLab.com 사용자)가 작성된 문서를 쉽게 사용할 수 있다는 높은 확신이 있는 경우.
기억하세요:
- GitLab에서는 문서를 코드와 같이 취급합니다. 코드처럼 문서도 품질을 보장하기 위해 검토되어야 합니다.
- 문서는 GitLab의 완료 정의의 일부입니다.
- 병합 전 기술 작성자 리뷰는 코드가 마일스톤 릴리스 전에 미리 완료되고 문서 변경 사항이 큰 경우에 가장 일반적이어야 합니다.
- 가능한 빨리 이동하는 코드를 병합해야 하는 중요한 문서에 대해 병합 후 기술 작성자 리뷰를 요청할 수 있습니다. 이 경우 기존 MR의 작성자가 기술 작성자로부터 제공된 피드백에 대응할 수 있습니다.
- 기술 작성자는 또한 문서가 기술 작성자 리뷰 없이 병합될 수 있는지 여부를 결정하는 데 도움을 줄 수 있으며, 이 경우 리뷰는 병합 직후에 수행됩니다.
기술 작성자 검토 없는 페이지
/doc/solutions 하위의 문서는 솔루션 아키텍트 팀이 생성, 유지, 복사/편집 및 병합합니다.
AI 생성 콘텐츠
GitLab 문서에 AI가 생성한 콘텐츠를 기여할 수 있으며, DCO 또는 CLA 조항 가이드라인을 준수한다면 가능합니다.
도움말