문서 작업 흐름

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 diff는 편집 내용을 명확히 강조하지 않습니다.

개별 커밋을 사용하면 검토자가 첫 번째 커밋 diff에서 위치 변경을 확인하고, 이후 커밋에서 콘텐츠 변경을 확인할 수 있습니다.

예를 들어, 페이지를 이동하고 페이지의 내용을 업데이트하는 경우:

첫 번째 커밋: 콘텐츠를 새 위치로 이동하고 필요하면 리다이렉트를 설정하세요. 가능하다면 이 커밋에서 손상된 링크를 수정하세요.
이후 커밋: 콘텐츠 변경을 하세요. 이미 수정하지 않은 링크는 수정하세요.
병합 요청에서: MR 설명 및 검토자에게 주석으로 커밋을 설명하세요.

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

문서 레이블

문서 또는 병합 요청을 작성할 때, 문서 템플릿을 선택하세요. 이 템플릿에는 병합 요청에 추가되는 레이블이 포함되어 있습니다:

~"type::feature" 또는 ~"type::maintenance"의 유형 레이블.
단계 레이블 및 그룹 레이블. 예를 들어, ~devops::create 및 ~group::source code.
~documentation 전문화 레이블.

기술 문서 작성 팀의 구성원이 ~Technical Writing 팀 레이블을 추가합니다.

참고: /doc/development/documentation을 제외하고, 기술 작가는 doc/development 디렉토리의 내용을 검토하지 않습니다. 어떤 Maintainer든 doc/development 디렉토리의 내용을 병합할 수 있습니다. doc/development 디렉토리의 내용에 대한 기술 작가 검토가 필요한 경우, #docs Slack 채널에서 요청하세요.

병합 후 리뷰

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

정기적인 사전 병합 기술 작가 검토가 생략될 수 있는 상황은 다음과 같습니다:

마일스톤 릴리스까지 남은 기간이 짧습니다. 남은 기간이 3일 미만인 경우 병합 후 검토를 요청하고 작성자를 Slack을 통해 태그하여 가능한 한 빨리 검토를 완료하도록 합니다.
변경 크기가 작고 기능의 초기 사용자(예: GitLab.com 사용자)가 작성된 대로 문서를 쉽게 사용할 수 있다는 높은 확신이 있습니다.

기억하세요:

GitLab에서는 문서를 코드처럼 취급합니다. 코드와 마찬가지로 문서도 품질 보장을 위해 검토되어야 합니다.
문서는 GitLab 완료 정의의 일부입니다.
사전 병합 기술 작가 검토는 코드가 마일스톤 릴리스보다 훨씬 전에 완료되고 더 큰 문서 변경에 대해 가장 일반적이어야 합니다.
코드가 가능한 한 빨리 병합될 수 있도록 하는 것이 중요한 경우 문서에 대한 병합 후 기술 작가 검토를 요청할 수 있습니다. 이 경우 원래 MR의 작성자가 이후 MR에서 기술 작가가 제공한 피드백을 처리할 수 있습니다.
기술 작가는 또한 기술 작가 검토 없이 문서가 병합될 수 있다고 결정할 수 있으며, 병합 후 곧 검토가 이루어질 것입니다.

기술 작가 검토 없는 페이지

/doc/solutions 하에 있는 문서는 솔루션 아키텍트 팀에 의해 작성, 유지 관리, 교정 및 통합됩니다.

AI 생성 콘텐츠

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

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