GitLab 문서 기여하기

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

문서 업데이트

필수 사항:

  • GitLab 팀 구성원이 아닌 경우, GitLab 문서를 업데이트하려면 포크에서 업데이트해야 합니다. 다음 중 하나를 선택할 수 있습니다:

문서를 업데이트하려면:

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

또는 /doc 디렉토리를 검색하고 싶지 않은 경우, https://docs.gitlab.com에서 페이지 하단에서 페이지 소스 보기 또는 웹 IDE에서 편집을 선택합니다. 변경 사항을 작성하기 전에 포크를 생성하거나 포크로 전환해야 합니다.

코드를 개발하는 경우, 문서를 업데이트하는 워크플로우가 약간 다릅니다. 세부 정보는 병합 요청 워크플로우를 참조하세요.

작업할 내용

문서를 업데이트하려면 이슈가 필요하지 않지만 작업할 문제를 찾고 싶다면, 새 기여자를 위해 정리된 문서 이슈 목록을 검토하세요(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. 다음 중 하나를 수행합니다:
    • 긴급한 도움이 필요한 경우, 이슈나 병합 요청에서 직접 기술 작성자에게 할당합니다.
    • 긴급하지 않은 도움이 필요한 경우, 이슈나 병합 요청에서 기술 작성자에게 핑을 보냅니다.

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

브랜치 명명

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

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

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