개요
어떠한 기능을 개발할때에 혼자하든 여러명이 하든 공통적인 개념을 관리하기 위해 위키라는 환경을 구성하고는 합니다.
주로 프로젝트의 설명 / 용어 사전 / 컨벤션 등 다양한 분야에서 사용되는 부분이 많습니다.
가장 많이 사용되는 건 노션 , MS teams ,github wiki등이 있죠.
현재 우리가 필요한건 용어사전과 컨벤션등을 관리하기 위해 필요한 환경으로느 github wiki가 가장 적합합니다.
github wiki 는 각종 컨벤션이나 용어사전 팀내 약속을 정하기 가장 효율적인 플랫폼입니다.
다만 제가 사용하지 않은 이유는 크게 2가지가 있습니다.
- 첫번째는 문서를 작성하고 확인하기 위한 과정이 불편하다.
- 마크다운 문법을 사용하긴 하지만, 레포지토리에 들어가서 작성해야 한다.
- 이로 인해 레포지토리에 들어가는 행위가 번거로워진다.
- 이로 인해 점점 손길을 잃어가며 죽은 문서가 된다.
- 두번째는 검색이 불편하다.
- 특정 용어를 찾기 위해서는 해당 문서의 파일명도 같이 알아야지만 검색이 가능하다.
- 이로 인해 검색이 불편하다. 어떤 개발에 대한 용어를 찾기 위해서는 레포지토리에 들어가서 파일명을 확인해야 한다.
- 이로 인해 검색이 불편하다.
이런 부분을 개선하기 위해 로컬에서도 사용해보았지만 결국 웹이랑 같은 불편함이 벌어졌습니다.
그래서 좀더 개선된 방식으로 아예 개발 환경에 딱 붙여두자! 라는 생각으로 서브모듈을 활용한 위키를 도입하도록 하였습니다.
0. 프로젝트 준비
현재 제가 이것저것 사용하는 프로젝트가 있습니다.
뭔가 테스트하거나 확인해볼게 있으면 주로 해당 레포에서 작업을 합니다.
이번에도 위키를 작성하는게 아닌 서브 모듈을 도입하는 것만 테스트할 것이니.
이 레포를 활용해보겠습니다.
1. github wiki의 git 주소를 확인
- https://github.com/Whale0928/springboot-practice.wiki.git
- 해당 GIT URL이 로컬에서 사용할수 있는 git repo입니다.
- 만약 서브모듈이 아니라 그냥 로컬에서 위키를 사용하고 싶으면 해당 깃을 가져오면 별도로 관리할수 있습니다.
2. 프로젝트 git에 sub module 추가
git submodule add {{ 위키 주소 }}
ex) git submodule add https://github.com/Whale0928/springboot-practice.wiki.git-
add 시 별 문제 없이 업로드 되는 것을 확인 할 수 있습니다.
-
이런 식으로
.gitmodules가 추가된것 또한 확인할 수 있습니다. -
또한 wiki 폴더도 추가된 것을 확인할 수 있습니다.
3. 새로운 파일을 업로드
- 파일을 업로드 할 때 주의점은 메인 브랜치에만 저장될수 있으니 주의해서 진행해야합니다.
- 아래의 이미지와 같이 모듈이 추가되지만 해당 모듈에만 값이 추가되면 실질적으로 위키에는 업데이트 되지 않습니다.
- 아래 이미지와 같이
root-repository.wiki를 기준으로 업데이트 진행해야합니다 - 만약 콘솔로 처리한다면 해당 모듈의 디렉토리까지 들어가서 진행해야 합니다.
