1/ template 다운로드 및 본인 로컬 컴퓨터에서 Markdown 작성
- Git Issue에 있는 템플릿을 다운로드
- 본인 local 컴퓨터에서 docs 작성(본인이 사용하기 편한 편집기 사용 ex. Obsidian)
2/ Docs 경로 접속
https://github.com/brickstudy/Docs
3/ Github 화면에서 "Create new file" 클릭
- 일단은 편의성을 위해 Github 웹에서 파일 추가!!
- 나중에는 본인 편한 방식으로 fork해서 사용해도 괜찮
4/ 경로 확인 및 내용 복사하기
- 경로 설정의 경우 "/"를 활용해 폴더를 만들면 됨!!
- 경로 규칙의 경우 Docs 생성 전에 담당자(민준)에게 문의
- 온보딩 같은 경우 "Docs/Onboarding/{발표주제}"로 작성
- 내용 복사 붙여넣기!!
- Commit Change 클릭
5/ 작성완료 후 Commit
- Commit message는 본인이 작업한 내용
- (6월 기준)은 main branch에 바로 merge
- 인원이 많아지면 문제가 생길 수 있기 때문에 7월 부터는 가이드 변경 예정!!
6/ gitbook 들어간 후 내용 확인
- gitbook 동기화의 경우 1~3분 정도 딜레이 있음