GitLab 문서 기여하기

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

다음 지침은 커뮤니티 기여자를 위한 것입니다.

문서 업데이트

전제 조건:

GitLab 커뮤니티 포크에 액세스 권한 요청. 커뮤니티 포크는 주요 GitLab 저장소의 공유 사본입니다. 요청을 하면 몇 가지 질문에 답해야 합니다. 기여자로 참여하고 싶다는 것을 알려주세요.

문서를 업데이트하려면:

GitLab 커뮤니티 포크의 /doc 디렉터리로 이동합니다.
업데이트하려는 문서 페이지를 찾습니다. 페이지가 어디에 있는지 확실하지 않으면 https://docs.gitlab.com의 페이지 URL을 확인합니다. 경로가 나열되어 있습니다.
오른쪽 상단에서 편집 > 단일 파일 편집을 선택합니다.
업데이트를 수행합니다.
완료되면 커밋 메시지 텍스트 상자에 커밋 메시지를 입력하십시오. 3-5단어를 사용하고 첫 번째 단어는 대문자로 시작하며 마침표로 단어를 끝내지 않습니다.
변경 사항 커밋을 선택합니다.
새로운 병합 요청이 엽니다.
새 병합 요청 페이지에서 문서 템플릿을 선택하고 템플릿 적용을 선택합니다.
설명란에 변경 사항에 대한 간단한 요약을 작성하고 연관된 이슈에 대한 링크를 추가합니다.
병합 요청 생성을 선택합니다.

병합 요청이 작성되면 GitLab Bot에서 작업을 검토할 준비가 되면 수행해야 할 작업에 대한 지침이 포함된 메시지를 찾으십시오.

문서를 업데이트하려면 이슈가 필요하지 않지만, 작업할 열린 이슈를 찾고 싶다면, 새 기여자를 위해 집중된 문서 이슈 목록을 검토하십시오.

원하는 이슈를 찾았다면:

이슈가 이미 다른 사람에게 할당되어 있다면 다른 이슈를 선택합니다.
이슈가 미할당 상태라면 코멘트를 추가하고 해당 이슈에서 작업할 것인지 물어봅니다. 해커톤에 대한 경우 @docs-hackathon을 사용합니다. 그 외에는 @gl-docsteam을 사용합니다. 예를 들어:
```
@docs-hackathon 이 이슈에서 작업하고 싶습니다
```

Vale 린팅 도구를 설치하고 실행하여 발생하는 문제를 해결할 수 있습니다.

다음 상황에서 기술 문서 팀에 도움이 필요한 경우:

도움이 필요한 사람을 식별하려면:

관련 DevOps 단계 그룹의 기술 작성자를 찾습니다.
다음 중 하나를 수행합니다:
- 긴급한 도움이 필요한 경우, 이슈나 병합 요청에서 기술 작성자를 직접 지정합니다.
- 긴급하지 않은 도움이 필요한 경우, 이슈나 병합 요청에서 기술 작성자를 언급합니다.

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

이미 GitLab 저장소의 자체 포크를 보유하고 있는 경우, GitLab 커뮤니티 포크 대신 사용할 수 있습니다.

https://docs.gitlab.com에서 편집하려는 페이지의 맨 아래로 스크롤합니다.
페이지 소스 보기를 선택합니다.
오른쪽 상단에서 편집 > 단일 파일 편집을 선택합니다.
업데이트를 수행합니다.
완료되면 커밋 메시지 텍스트 상자에 커밋 메시지를 입력하십시오. 3-5단어를 사용하고 첫 번째 단어는 대문자로 시작하며 마침표로 단어를 끝내지 않습니다.
변경 사항 커밋을 선택합니다.
브랜치 이름을 확인한 후 변경 사항 커밋을 선택합니다.

변경 사항은 마지막 단계에서 확인된 이름의 브랜치에 GitLab 저장소의 자체 포크에 추가되었습니다.

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

병합 요청을 생성한 후 GitLab Bot에서 작업을 검토할 준비가 되면 수행해야 할 작업에 대한 지침이 포함된 메시지를 찾으십시오.