FLYAI docs 가이드

FLYAI docs 주소

• https://flyai4-1.gitbook.io/docs/

FLYAI docs 작성 가이드

1. FLYAI4/docs repo에서 본인 repo로 fork

2. 파일 작업 전 branch 최신 상태 유지

• Sync fork - Update branch

3. 파일경로와 파일명 설정 후 내용 작성

• 로컬에서 작업해도 괜찮고, markdown 파일을 작성하기 때문에 아래와 같이 github에서 작업 가능
• 파일경로는 우선 DataScience, DataEngineering, Infra 3개로 운영할 예정 (새로운 폴더가 필요할 경우 관리자에게 요청!!)
• 현재 생성된 폴더명 유지, 파일명은 자유롭게 작성 가능
• commit changes 버튼 클릭

3. 브런치 설정

• 브런치명 규칙 폴더명/파일명 (브런치 관리를 위해 규칙 설정)
• 예시 이미지 기준 DataScience/README

4. FLYAI4/docs repo로 설정 후 PR 생성

• compare accross forks를 누르고 FLYAI4/docs repo 로 베이스 repo로 설정
• base repository가 제대로 설정되었는지 확인 후 Create pull request 클릭

5. 관리자가 PR 승인할 수 있도록 설명 추가 후 PR 요청

• 내용 작성 후 Create pull request 클릭

6. gitbook에 정상 업로드 확인

• 관리자가 PR 및 gitbook 업로드 확인 후 회신
• 회신 받으면 링크 접속 후 업로드 확인
• 팀원 공유