협업하여 문서 작성하기
Gitbook은 직관적으로 작업할 수 있는 인터페이스를 제공하기 때문에 문서 퍼블리싱 하기에 기술된 절차를 참고하시어 공유문서 편집을 진행하시길 바라며, 다른 소스관리툴 등의 경험으로 인해 Gitbook의 협업체계가 혼동스럽거나, 보다 자세한 이해가 필요할 경우 본 장을 참고하시길 바랍니다.
1. Gitbook의 협업구조
현재 Merge된 Main 버전에서 새로운 draft버전(=Branch 개념)으로 협업을 진행하려면 'change request' (= 'Edit 버튼 누르기')를 이용해 Main에서 분리된 새로운 draft 버전에서 작업을 하고, 작업을 완료한 후 Main으로 'Merge'할 수 있습니다.
2. 'Change request'(=Edit)를 이용해 협업하기
Gitbook의 버전관리 방법은 소스관리 툴인 Git의 Main과 branch 버전 관리와 유사한 개념을 적용하고 있습니다.
사내 공유문서와 같이 퍼블리싱되어 있는 Space에 신규 콘텐츠를 추가하거나 수정하는 작업은 'Change request'를 통해 이루어 집니다. 'Change request'는 'Edit in branch' 의 개념으로 main 버전에서 새로운 draft 버전을 생성하고 작업완료 후 'Merge'를 이용해 새로운 Main 버전으로 릴리즈 됩니다.
아래 그림의 초록색은 Space의 우측상단에 표시되는 수행 버튼을 표시하며, 해당 버튼을 수행 시 Main과 Change request(Branch 개념)가 어떻게 관리 되는지를 보여줍니다.
Space의 우측 상단의 'Edit' 버튼을 누르면 새로운 'Change request'를 시작합니다. 'Change request'를 통해 저자는 Main에서 새로 Branch한 draft 버전에서 편집을 수행할 수 있습니다. ('Change Request'는 Git의 Main 버전에서 새로운 Branch 분기와 유사한 개념)
3. Draft 버전을 이용한 문서 관리
편집 중이던 페이지 창을 닫거나 다른 페이지로 이동한 경우
Review(Submit for review) 요청 혹은 Merge 하기 전, 장시간 문서 편집이 필요한 경우
특정 Draft 버전을 여러 동료 작성자와 함께 동시에 편집할 경우
* 편집 중인 창을 닫거나 편집하던 창이 사라진 경우
해당 스페이스의 sub-navigation 왼쪽 상단의 'Change Requests'탭을 클릭 후 오른쪽의 'Draft' 탭에서 이전에 편집중이던 작업페이지를 불러와 계속 편집을 할 수 있습니다.
새로운 편집을 시작 시 문서의 draft 버전에 설명을 추가해두면, 편집 중단 된 곳으로 복원하기 수월합니다. git commit -m " commit 포인트에 관한 설명"이라고 이해하시면 편리합니다.
Last updated
Was this helpful?