GitLab 문서 기여하기

GitLab 문서는 GitLab을 구성하고 사용하며 문제를 해결하는 방법에 대한 진정한 단일 출처(SSoT)입니다.

모든 사람은 GitLab 문서에 기여할 수 있습니다.

다음 지침은 커뮤니티 기여자에게 해당됩니다.

문서 업데이트하기

선행 조건:

요청할 때 몇 가지 질문에 답변하도록 요청받습니다. GitLab 문서에 기여하고 싶다는 사실을 알려주세요.

문서를 업데이트하려면:

  1. GitLab 커뮤니티 포크의 /doc 디렉토리로 가세요.

  2. 업데이트하려는 문서 페이지를 찾습니다.

페이지가 어디에 있는지 확실하지 않은 경우, https://docs.gitlab.com에서 페이지의 URL을 확인하세요.

경로가 그곳에 나열되어 있습니다.

  1. 오른쪽 상단에서 Edit > Edit single file을 선택합니다.

  2. 업데이트를 진행합니다.

  3. 작업이 완료되면 Commit message 텍스트 상자에 커밋 메시지를 입력합니다.

3-5단어를 사용하고 첫 단어는 대문자로 시작하며 문장 끝에 마침표를 사용하지 마세요.

  1. Commit changes를 선택합니다.

  2. 새 병합 요청이 열립니다.

  3. New merge request 페이지에서 Documentation 템플릿을 선택하고 Apply template을 선택합니다.

  4. 설명란에 변경 내용의 간략한 요약과 관련 문제에 대한 링크를 작성합니다.

문제가 있다면 링크를 포함하세요.

  1. Create merge request를 선택합니다.

병합 요청을 만들면 GitLab Bot의 메시지를 확인하세요. 이 메시지는 검토 준비가 완료되면 무엇을 해야 하는지에 대한 지침이 포함되어 있습니다.

무엇을 작업할 것인가

문서를 업데이트하는 데 문제가 필요하지는 않지만, 작업할 열린 문제를 찾고 있다면,

신규 기여자를 위해 특별히 선별된 문서 문제 목록을 검토하세요.

작업할 문제를 찾으면:

  • 문제가 이미 누군가에게 할당되어 있다면, 다른 문제를 선택하세요.

  • 문제가 할당되지 않았다면 댓글을 추가하고 작업하고 싶다고 요청하세요. 해커톤에서는 @docs-hackathon을 사용하세요. 그렇지 않으면 @gl-docsteam을 사용하세요. 예를 들어:

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

Vale linting tool을 설치하고 실행하여 발생하는 문제를 수정할 수 있습니다.

도움 요청하기

다음 경우에 기술 문서 팀에 도움을 요청하세요:

  • 문서를 위한 올바른 위치를 선택하는 데 도움이 필요합니다.

  • 문서 아이디어나 개요에 대해 논의하고 싶습니다.

  • 다른 도움을 요청하고 싶습니다.

도움을 줄 수 있는 사람을 식별하려면:

  1. 관련 DevOps 단계 그룹에서 기술 작가를 찾습니다.

  2. 아래 중 하나를 수행합니다:

    • 긴급한 도움이 필요한 경우, 문제나 병합 요청에서 기술 작가를 직접 할당합니다.
    • 긴급하지 않은 도움이 필요한 경우, 문제나 병합 요청에서 기술 작가에게 핑을 보냅니다.

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

본인의 포크에서 문서 수정하기

GitLab 저장소의 본인 포크가 이미 있는 경우, GitLab 커뮤니티 포크를 사용하기보다 본인 포크를 사용할 수 있습니다.

  1. https://docs.gitlab.com에서 수정하려는 페이지의 맨 아래로 스크롤합니다.

  2. 페이지 소스 보기를 선택합니다.

  3. 오른쪽 상단에서 수정 > 단일 파일 수정을 선택합니다.

  4. 업데이트 내용을 작성합니다.

  5. 완료되면 커밋 메시지 텍스트 상자에 커밋 메시지를 입력합니다.
    3-5 단어를 사용하고 첫 단어는 대문자로 시작하며 문장 부호로 끝내지 마십시오.

  6. 변경 사항 커밋을 선택합니다.

  7. 자신의 브랜치 이름을 기록한 다음 변경 사항 커밋을 선택합니다.

변경 사항이 여러분의 포크된 저장소의 브랜치에 추가되었습니다.

이제 병합 요청을 생성합니다. 이 병합 요청은 여러분의 브랜치에서 변경 사항이 GitLab의 master 브랜치에 병합되는 방식입니다.

  1. 왼쪽 사이드바에서 코드 > 병합 요청을 선택합니다.

  2. 새 병합 요청을 선택합니다.

  3. 소스 브랜치로 본인의 포크와 브랜치를 선택합니다.

  4. 대상 브랜치로 GitLab 저장소의 master 브랜치를 선택합니다.

  5. 브랜치 비교 및 계속을 선택합니다. 새 병합 요청이 열립니다.

  6. 새 병합 요청 페이지에서 문서 템플릿을 선택하고 템플릿 적용을 선택합니다.

  7. 설명란에 변경 사항의 간단한 요약을 작성하고 관련 문제에 링크를 추가합니다. 문제가 있는 경우에만 합니다.

  8. 병합 요청 생성을 선택합니다.

병합 요청이 생성되면 GitLab Bot의 메시지를 찾으십시오. 이 메시지에는 검토 준비가 되었을 때 수행해야 할 작업에 대한 지침이 포함되어 있습니다.