Apache Pinot 문서 기여하기
Apache Pinot 문서 기여하기 (Contribute Pinot Documentation)
Apache Pinot 문서에 기여하는 방법을 다루는 문서예요. Pinot 문서는 GitBook으로 운영돼요.
출처: 문서
본문
Pinot 문서는 GitBook으로 운영돼요.
콘텐츠 백업을 위한 양방향 GitHub 통합이 있어요. https://github.com/pinot-contrib/pinot-docs에서 찾을 수 있어요.
문서 업데이트를 제안하려면 아래 지침을 따라요.
업데이트 제안하기 (Make suggested updates)
Pinot 문서 저장소 fork·clone (Fork and clone the Pinot documentation repository)
Git과 GitHub에 익숙하다면 pinot-docs 저장소를 fork할 수 있어요. 이렇게 하면 https://github.com/{yourusername}/pinot-docs에서 찾을 수 있는 자신만의 저장소 버전이 생기는데, {yourusername}은 GitHub에서 만든 사용자 이름이에요.
fork에서 clone해 로컬 머신으로 가져오세요.
변경하기 (Make changes)
머신에서 로컬로 문서를 수정해요. 커밋할 때 의미 있고 명확한 커밋 메시지를 작성하세요:
git commit -m 'Fixes a typo on the Update Documentation page'
그런 다음 GitHub의 fork에 변경 사항을 푸시하세요.
풀 리퀘스트 제출 (Submit a pull request)
검토를 위해 GitHub 웹 인터페이스를 사용해 풀 리퀘스트(PR)를 만들어요.
리뷰 받고 반영하기 (Get and incorporate review)
기다리세요. Pinot 문서 팀은 보통 며칠 내에 풀 리퀘스트를 검토해요. 제안이나 변경이 요청될 수 있어요. 로컬 브랜치를 업데이트하고 변경 사항을 푸시해 반영할 수 있어요.
PR이 승인되면 코드 소유자 중 한 명이 병합해요. 그러면 변경 사항이 해당 GitBook 페이지에 자동으로 나타나요.
모든 GitBook 문서는 Markdown 문법을 따른다는 점에 유의하세요.
GitBook에서 직접 편집 (Edit directly on GitBook)
활발하고 신뢰받는 기여자라면 GitBook UI로 문서를 직접 편집할 접근 권한을 요청할 수 있어요.
편집 권한 요청과 편집하거나 추가하고 싶은 콘텐츠 설명과 함께 [email protected]로 사이트 관리자에게 이메일을 보내세요.
이 방법으로 만든 변경은 이 커밋에서 볼 수 있듯이 GitHub 저장소에 자동으로 병합돼요.
스타일과 형식 (Style and formatting)
Pinot의 모든 문서는 Markdown으로 작성돼요.
스타일 지침은 Apache Pinot 스타일 가이드를 보세요.