문서 작성 흐름

GitLab의 문서 작성은 특정 흐름을 따릅니다.

병합하기 전에

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

제품 가용성 세부 정보.
해당 기능을 도입한 GitLab의 버전.
정확한 링크.
정확한 사용자 권한.

브랜치 이름

GitLab 프로젝트의 CI/CD 파이프라인은 문서 변경 사항만 포함하는 병합 요청에서 짧고 빠른 파이프라인을 실행하도록 구성되어 있습니다.

Omnibus, Charts 또는 Operator에 문서 전용 변경을 제출하는 경우, 더 짧은 파이프라인을 실행하려면 브랜치 이름을 지정할 때 다음 가이드를 따라야 합니다:

브랜치 이름	유효한 예시
`docs/`로 시작	`docs/update-api-issues`
`docs-`로 시작	`docs-update-api-issues`
`-docs`로 끝나는	`123-update-api-issues-docs`

콘텐츠 이동

콘텐츠를 새 위치로 이동하고 동시에 콘텐츠를 편집하는 경우, 별도의 커밋을 사용하세요.

별도의 커밋을 사용하면 리뷰어가 이동된 콘텐츠에 대한 MR 차이가 명확하게 강조되지 않기 때문에 도움이 됩니다. 별도의 커밋을 사용하면 리뷰어가 첫 번째 커밋 차이에서 위치 변경을 확인한 후, 이후 커밋에서 콘텐츠 변경을 확인할 수 있습니다.

예를 들어, 페이지를 이동하면서 페이지 내용도 업데이트하는 경우:

첫 번째 커밋: 콘텐츠를 새 위치로 이동하고 필요한 경우 리다이렉트를 설정하세요. 가능하다면 이 커밋에서 깨진 링크를 수정하세요.
다음 커밋들: 콘텐츠를 수정하세요. 이미 깨진 링크를 수정하세요.
병합 요청에서: MR 설명과 리뷰어에게 코멘트로 커밋을 설명하세요.

원하는 만큼 많은 커밋을 추가할 수 있지만, 첫 번째 커밋은 콘텐츠를 이동만 하고 편집하지 않도록 해야 합니다.

문서 라벨

이슈 또는 병합 요청을 작성할 때 다음의 문서 템플릿을 선택하세요. 이 템플릿에는 다음의 라벨이 추가됩니다.

유형 라벨 중 하나인 ~"type::feature" 또는 ~"type::maintenance".
단계 라벨 및 그룹 라벨. 예: ~devops::create, ~group::source code.
~documentation 전문 라벨.

기술 문서 작성팀의 구성원은 ~Technical Writing 팀 라벨을 추가합니다.

참고: /doc/development/documentation을 제외한 경우, 기술 작성자는 doc/development 디렉토리의 내용을 리뷰하지 않습니다. 유지 관리자는 doc/development 디렉토리의 내용을 병합할 수 있습니다. doc/development 디렉토리의 내용을 기술적 작성자가 리뷰하길 원할 경우, #docs Slack 채널에서 요청하세요.

병합 후 리뷰

병합 전 기술 작성자에게 할당되지 않은 경우, 개발자 또는 유지 관리자가 즉시 리뷰를 예약해야 합니다. 이를 위해 병합된 병합 요청에서 생성되는 이슈를 사용하여 문서 리뷰 설명 템플릿을 만들고 링크를 연결하세요.

정규 병합 전 기술 작성자 리뷰를 건너뛸 수 있는 경우:

마일스톤 릴리스 전에 남은 시간이 적을 경우. 3일 미만으로 남아 있다면 병합 후 리뷰를 요청하고 리뷰가 가능한 빨리 완료되도록 Slack을 통해 기술 작성자에게 피드백을 요청하세요.
변경 사항의 크기가 작으며 해당 기능의 초기 사용자(예: GitLab.com 사용자)가 문서를 쉽게 사용할 수 있다고 높은 확신이 있는 경우.

기억하세요:

GitLab에서는 문서를 코드처럼 취급합니다. 코드와 마찬가지로 품질을 보장하기 위해 문서를 리뷰해야 합니다.
문서는 완료 정의의 일부입니다.
병합 전 기술 작성자 리뷰는 코드가 마일스톤 릴리스보다 앞서 완료되거나 문서 변경이 큰 경우에 가장 흔히 요청됩니다.
가능한 빨리 병합된 코드와 함께 문서의 후속 MR에서 기술 작성자의 피드백을 처리할 수 있습니다.
기술 작성자는 문서 리뷰 없이도 문서가 병합될 수 있는 경우를 결정하는 데 도움을 줄 수 있습니다. 그 경우, 기존 MR의 저자가 기술 작성자가 제공한 피드백을 처리할 수 있습니다.
기술 작성자는 문서 리뷰 없이도 문서가 병합될 수 있는 경우를 결정하는 데 도움을 줄 수 있습니다. 그 경우, 기존 MR의 저자가 기술 작성자가 제공한 피드백을 처리할 수 있습니다.

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

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

AI 생성 콘텐츠

커뮤니티 구성원은 DCO 또는 CLA 약관의 가이드라인을 따르는 경우 GitLab 문서에 AI 생성 기여를 할 수 있습니다.

GitLab 팀 구성원은 내부 핸드북에 문서화된 가이드라인을 따라야 합니다.