FLYAI docs 가이드

FLYAI docs 주소

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

FLYAI docs 작성 가이드

아래 예시 이미지는 현재와 다른 곳에서 가져온 것으로 방법만 확인

1. FLYAI4/docs repo에서 Add file-Create new file 버튼 클릭

2. 파일경로와 이름을 설정 후 내용 작성

• 파일경로는 우선 DataScience, DataEngineering, Infra 3개로 운영할 예정(새로운 경로가 필요할 경우 관리자에게 요청해주세요!!)
• 파일명 작성 후 현재 파일 경로와 파일명은 잘 확인해주세요!!(파일경로/파일명 이 branch 명으로 설정해야만 이후 git action이 적용됩니다.)
• 내용 작성 후 commit change 버튼 눌러주세요!!(내용 임시 저장을 위해 작성 전 중간중간에 해당 버튼눌러 저장해주세요.)

3. 브런치 명 설정

• 브런치 명은 .md를 제외한 폴더명/파일명 으로 생성해주세요
• 예시기준 python/hello_test

4. PR 생성 후 git action 적용대기

• PR 생성 후 push할 때 자동으로 작성자, 작성일자가 추가되는 기능이 적용되어 있습니다.
• git action 적용까지 20초 정도 대기 해주세요

5. gitbook에 정상 업로드 확인 및 팀원 공유

• 링크 접속 후 업로드 확인
• 팀원 공유

Author : robert-min / Last Update : 2023-12-24