• 문서 업데이트
• 작업할 내용
• 도움 요청
• 브랜치 이름

GitLab 문서 기여

GitLab 문서는 GitLab의 구성, 사용 및 문제 해결 방법에 대한 정보를 담고 있는 진실의 단일 소스(SSOT)입니다. 누구나 GitLab 문서에 기여할 수 있습니다.

문서 업데이트

사전 조건:

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

문서를 업데이트하려면:

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

다른 방법으로, \doc 디렉터리를 찾고 싶지 않다면, https://docs.gitlab.com에서 페이지 하단의 페이지 소스 보기 또는 웹 IDE에서 편집 을 선택합니다. 변경을 가하려면 먼저 포크를 생성하거나 포크로 전환해야 합니다.

코드를 개발하는 경우, 문서를 업데이트하는 워크플로우가 조금 다릅니다. 자세한 내용은 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