GitLab 문서에 기여하기

GitLab 문서에 기여하는 방법과 문서 업데이트, 이슈 선택, 도움 요청, 개인 포크를 통한 편집 방법을 설명합니다.

GitLab 문서는 GitLab을 구성하고, 사용하고, 문제를 해결하는 방법에 관한 단일 진실 공급원(Single Source Of Truth, SSOT)입니다. 누구나 GitLab 문서에 기여할 수 있습니다. 다음 안내는 커뮤니티 기여자를 위한 내용입니다. 문서 업데이트 # 사전 요구 사항: 기여자 온보딩을 시작 하여 커뮤니티 포크에 접근 권한을 얻으세요. 커뮤니티 포크는 GitLab 메인 리포지터리의 공유 사본입니다. 요청 시 몇 가지 질문에 답해야 합니다. GitLab 문서에 기여하고 싶다고 알려주세요. 문서를 업데이트하려면: GitLab 커뮤니티 포크에서 /doc 디렉터리 로 이동합니다. 업데이트할 문서 페이지를 찾습니다. 페이지 위치를 모르는 경우, https://docs.gitlab.com 의 페이지 URL을 확인하세요. 경로가 표시되어 있습니다. 또는, 이미 업데이트하려는 문서 페이지에 있다면 하단으로 스크롤하여 푸터에서 View page source 를 선택하세요. 이 링크를 클릭하면 소스 파일로 바로 이동합니다. 오른쪽 상단에서 Edit > Edit single file 을 선택합니다. 수정 내용을 작성합니다. 완료되면 Commit message 텍스트 상자에 커밋 메시지를 입력합니다. 3~5개의 단어를 사용하고, 첫 번째 단어는 대문자로 시작하며, 구문 끝에 마침표를 붙이지 않습니다. Commit changes 를 선택합니다. 새 머지 리퀘스트가 열립니다. New merge request 페이지에서 Documentation 템플릿을 선택하고 Apply template 을 선택합니다. 설명란에 변경 사항에 대한 간략한 요약을 작성하고, 관련 이슈가 있는 경우 해당 이슈를 링크합니다. Create merge request 를 선택합니다. 머지 리퀘스트가 생성된 후 GitLab Bot 의 메시지를 확인하세요. 이 메시지에는 리뷰 준비가 완료되었을 때 해야 할 작업에 대한 안내가 포함되어 있습니다. 작업할 내용 # 문서를 업데이트하기 위해 이슈가 반드시 필요한 것은 아니지만, 작업할 열린 이슈를 찾고 있다면 신규 기여자를 위해 선별된 문서 이슈 목록 을 검토하세요. 작업할 이슈를 찾았다면: 이슈가 이미 다른 사람에게 할당되어 있다면, 다른 이슈를 선택하세요. 이슈가 할당되지 않은 경우, 이슈 설명에서 기여 방법을 확인하세요. 일부 이슈는 여러 기여자가 함께 작업할 수 있으며, 이슈에 할당되지 않아도 작업할 수 있습니다. 그렇지 않은 경우, 댓글을 추가하여 (작성자를 멘션하여) 해당 이슈 작업 의사를 밝히세요. Vale 린팅 도구 를 설치하고 실행하여 발견된 이슈를 수정해볼 수도 있습니다. 번역된 문서 # GitLab 문서를 전 세계에서 더 쉽게 사용할 수 있도록, 제품 문서를 다른 언어로 번역하여 게시할 계획입니다. 파일 구조 와 초기 번역본이 만들어졌지만, 이 프로젝트는 아직 완료되지 않았습니다. 번역된 문서의 공식 공개 릴리즈 후, 번역 개선에 참여하는 방법에 대한 세부 정보를 공유할 예정입니다. 그러나 이 작업이 진행 중