• 문서 업데이트
• 작업할 내용
• 도움 요청
• 브랜치 네이밍
• 오래된 브랜치에 문서 변경 사항 되감아 넣기

GitLab 문서 기여하기

GitLab 문서는 GitLab의 구성, 사용 및 문제 해결에 대한 정보에 대한 단일 정보 원본(SSOT)입니다. 누구나 GitLab 문서에 기여할 수 있습니다.

문서 업데이트

필수 조건:

• GitLab 팀 구성원이 아닌 경우, fork에서 GitLab 문서를 업데이트해야 합니다. 다음 중 하나를 선택할 수 있습니다:
  • GitLab 커뮤니티 fork에 대한 액세스 요청
  • 개인적으로 fork를 생성하세요. GitLab 리포지터리로 이동하여 오른쪽 상단에서 Fork를 선택하세요.

문서를 업데이트하려면:

1. GitLab 커뮤니티 fork 또는 개인 fork로 이동합니다.
2. \doc 디렉터리에서 문서 페이지를 찾습니다.
3. 오른쪽 상단에서 편집 > 단일 파일 편집을 선택합니다.
4. 변경 사항을 가합니다.
5. 변경 사항을 제출할 준비가 되면 커밋 메시지 텍스트 상자에 커밋 메시지를 입력합니다. 3-5 단어를 사용하고 첫 글자는 대문자로 시작하며, 마침표로 끝내지 않습니다.
6. 변경 사항 커밋을 선택합니다.
7. 커뮤니티 fork에서 작업 중이라면 새 Merge Request이 열리고 다음 단계를 계속할 수 있습니다. 개인 fork에서 작업 중이라면 먼저 다음을 진행하세요:
   1. 왼쪽 사이드바에서 코드 > Merge Request을 선택합니다.
   2. 새 Merge Request을 선택합니다.
   3. 소스 브랜치에는 fork 및 브랜치를 선택합니다. 브랜치를 생성하지 않은 경우에는 master를 선택합니다. 대상 브랜치에는 GitLab 리포지터리의 master 브랜치를 선택합니다.
   4. 브랜치 비교 및 계속을 선택합니다. 새 Merge Request이 엽니다.
8. 새 Merge Request 페이지에서 문서 템플릿을 선택하고 템플릿 적용을 선택합니다.
9. 설명에 변경 사항에 대한 간단한 요약을 작성하고 연관된 문제에 링크를 포함합니다(있는 경우).
10. Merge Request 생성을 선택합니다.
11. Merge Request을 생성한 후, GitLab Bot에서 언제 검토를 준비했을 때 무엇을 해야 하는지에 대한 지침을 찾아보세요.

또는, 만약 /doc 디렉터리를 찾고 싶지 않다면, https://docs.gitlab.com에서 페이지 하단에서 페이지 소스 보기 또는 Web IDE에서 편집을 선택하세요. 변경 사항을 가기 전에 fork를 생성하거나 귀하의 fork로 전환하라는 프롬프트가 표시됩니다.

코드를 개발 중이라면, 문서를 업데이트하는 워크플로는 약간 다릅니다. 상세 내용은 Merge Request 워크플로를 참조하세요.

작업할 내용

문서를 업데이트하려면 문제가필요하지 않지만, 업데이트할 오픈된 문제를 찾고 있다면, 새 기여자를 위해 고안된 문서 문제 디렉터리을 검토하세요(https://gitlab.com/gitlab-org/gitlab/-/issues/?sort=created_date&state=opened&label_name%5B%5D=documentation&label_name%5B%5D=docs-only&label_name%5B%5D=Seeking%20community%20contributions&first_page_size=20).

작업하고 싶은 문제를 찾았다면:

• 문제가 이미 다른 사람에게 할당된 경우 다른 문제를 선택하세요.

• 문제가 미할당 상태인 경우, 코멘트를 추가하고 그 문제에서 작업할 것인지 물어보세요. 해커톤을 위해서는 @docs-hackathon을 사용하세요. 그렇지 않으면 @gl-docsteam을 사용하세요. 예시:

  @docs-hackathon 이 문제를 작업하고 싶습니다
  

Vale linting tool을 설치하고 실행하여 발생하는 문제를 수정해보세요.

도움 요청

기술 문서 팀에게 다음과 같이 도움이 필요한 경우:

• 문서를 올바른 위치로 선택하는 데 도움이 필요한 경우.
• 문서 아이디어 또는 개요를 논의하고 싶은 경우.
• 다른 도움을 요청하고 싶은 경우.

도움을 받을 사람을 식별하려면:

1. 해당되는 DevOps 단계 그룹에 대한 기술 작가를 찾습니다.
2. 다음 중 하나:
   • 긴급 도움이 필요한 경우, 문제나 Merge Request에서 기술 작가를 직접 지정하세요.
   • 비긴급 도움이 필요한 경우, 문제나 Merge Request에서 기술 작가를 멘션하세요.

만약 GitLab Slack 워크스페이스의 구성원이라면, #docs 채널에서 도움을 요청할 수 있습니다.

브랜치 네이밍

GitLab 주 프로젝트의 CI/CD 파이프라인은 문서 변경만 포함하는 Merge Request을 위해 더 짧고 빠른 파이프라인을 실행하도록 구성되어 있습니다.

Omnibus, Charts 또는 Operator에 문서 전용 변경 사항을 제출하려면, 브랜치 이름을 다음 가이드라인을 따라야 합니다:

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

오래된 브랜치에 문서 변경 사항 되감아 넣기

예외적인 경우를 제외하고, 오래된 브랜치로 문서 변경 사항을 되감아 넣는 것은 드물게 이루어져야 합니다. 그 기준은 법적 문제, 긴급 보안 수정, 사용자들이 업그레이드하는 것을 방해하거나 데이터 손실을 유발할 수 있는 콘텐츠 수정입니다.

두 가지 유형의 되감아 넣기가 있습니다:

• 최신 안정 버전: 유지보수자(백엔드, 프론트엔드, 문서)는 일반적으로 버그 수정뿐만 아니라 중요한 문서 변경 사항도 포함하는 변경 사항을 최신 안정 버전으로 되감아 넣을 수 있습니다.
• 오래된 안정 브랜치: 유지 보수 정책이 준수되도록 하기 위해, 오래된 안정 브랜치로의 Merge은 릴리스 매니저에게 제한되어 있습니다.

오래된 브랜치로의 변경 사항 되감아 넣기를 하려면 기술 문서 프로젝트에서 새 문제를 엽니다 및 문제 템플릿에 따라 진행하세요.