지금 GitLab으로 프로젝트를 관리하신다면, 이 글을 보고 GitLab Wiki를 시작해 보시면 어떨까요? Wiki는 GitLab 인스턴스 안에서 직접 문서를 만들고, 정리하며, 공유하는 도구입니다. 이는 프로젝트와 가까이 있으며, 프로젝트 활동을 쉽게 녹일 수 있는 문서이기도 하죠. Wiki를 잘 활용하면, 팀이 원활히 협업하고, 지식 관리를 최적화하는 데 도움이 됩니다. 이 글에서는 DevOps 실무자가 Wiki를 효과적으로 활용하는 방법을 소개하겠습니다.
GitLab Wiki 장점

GitLab Wiki는 프로젝트와 관련된 문서를 작성하고 관리하는 도구입니다. 이는 GitLab 프로젝트와 그룹 수준에서 모두 사용할 수 있고요. Markdown, RDoc, AsciiDoc, Org 등 여러 형식을 지원하죠. 이로써 정보를 보기 쉽게 표시합니다.
Wiki는 팀이 GitLab의 단일 플랫폼 안에서 애자일 계획 프로세스를 간소화하고, 협업을 강화하는 데 도움이 됩니다. 아울러 중요한 정보에 접근하고, 이를 최신 상태로 유지하는 데 유용하죠. 아래는 GitLab 프로덕트 매니저인 Matthew Macfarlane이 설명한 Wiki의 장점과 제 의견을 아우른 내용입니다.
-
중앙 집중식 정보 저장소
Wiki는 모든 지식을 저장하는 단일 진실 공급원으로 역할을 합니다. Wiki를 사용하면, 외부 솔루션을 찾기 위해 플랫폼을 떠나지 않고도 필요한 정보를 쉽게 찾을 수 있습니다.
-
정보 접근과 협업 편의성
Wiki로 문서를 작업할 때, GitLab의 이슈, Merge request(MR)에 쉽게 접근해 정보를 파악할 수 있습니다. 또 링크와 미리보기로 팀에서 편리하게 협업할 수 있습니다.
-
버전 제어
Wiki는 GitLab의 버전 제어 시스템에 따라 작동됩니다. 이는 모든 변경 사항을 추적하고, 필요하면 이전 버전을 복원할 수 있습니다. 이는 시간이 지나면서 문서의 무결성을 유지하는 데 도움이 됩니다.
-
템플릿
템플릿을 사용해 여러 페이지의 콘텐츠를 일관된 형식과 스타일로 유지할 수 있습니다. 이는 문서의 전문성과 가독성을 향상합니다. 템플릿은 재사용할 수 있어 문서 작성 시간을 줄여줍니다.
Wiki 단계별 활용 가이드
어떻게 하면 Wiki의 장점을 잘 활용할 수 있을까요? 지금부터 Wiki 사용법을 단계별로 실습하며, 효과적인 Wiki 활용 노하우를 소개하겠습니다.
Wiki 첫 페이지 생성
Wiki 활용의 첫걸음은 페이지 생성에서 시작합니다. 다음 순서대로 작업하세요.
-
GitLab Project 혹은 Group > Plan > Wiki 메뉴에 진입합니다.
-
Create your first page 버튼을 눌러 첫 페이지를 생성합니다.
-
Title, Path, Content, Commit message 항목에 내용을 입력합니다.
- Title: 문서 제목을 입력합니다. 문서 작성이 완료되면 오른쪽 사이드바에 표시됩니다.
- Path: 문서 경로를 입력합니다.
/
로 문서 위치를 구분합니다. 이는 기본적으로 문서 제목에 기반해 자동 입력됩니다. 아래 Generate page path from title 체크박스를 해제하면, 경로를 수동으로 바꿀 수 있습니다. 그러나 임의로 변경한 모든 경로를 다 기억하기 어려우므로 문서 제 목에 기반한 경로를 유지하는 걸 추천합니다. 이 예시에서는 Wiki 페이지의 첫 번째 경로가 ‘home’으로 고정됐기에 첫 번째 페이지의 경로는 반드시 ‘home’으로 입력합니다. - Content: 문서 내용을 입력합니다.
- Commit message: 커밋 메시지를 입력합니다.
-
작성을 완료하면, Create Page 버튼을 눌러 페이지를 생성합니다.
페이지 추가
Wiki에서 페이지를 추가하는 방법은 3가지입니다. 이 중 가장 편리한 방법을 찾아 활용하세요.
-
Wiki 페이지 오른쪽 상단의 케밥(세 개의 점으로 된 아이콘) 메뉴를 클릭한 다음, New page를 클릭합니다(경로 자동 입력 없음).
-
오른쪽 사이드바 페이지 메뉴에 마우스를 올리면 등장하는 + 버튼을 클릭합니다(경로 자동 입력).
-
문서 작성 시 링크 텍스트(용어 정리)의 URL에 미래에 추가할 페이지 경로를 입력합니다(경로 자동 입력).
-
이렇게 작성한 링크 텍스트(용어 정리)를 클릭하면, 해당 경로의 페이지 생성 페이지로 이동합니다.
-
새 페이지에서 경로(Path)를 입력할 때, 띄어 쓰려면
-
를 입력하세요!
-
사이드바 활용
생성된 페이지로 이동하는 페이지 버튼은 Wiki 페이지 오른쪽 사이드바에 나열됩니다. 사이드바 구성과 맞춤형 설정 방법을 알아보겠습니다.
- 구성
/
로 나눠진 경로(Path)의 깊이(depth)에 따라 페이지 버튼이 오른쪽 사이드바에 노출됩니다.- 사이드바에서는 페이지별 목차도 보여줍니다. heading1~6까지 나옵니다.
- 사이드바에는 페이지 버튼이 최대 5000개 표시됩니다. 그 이상 보려면, View all pages를 클릭합니다.
- 맞춤형 설정
- 사이드바 오른쪽 상단의 톱니바퀴 버튼을 클릭합니다.
- Edit custom sidebar의 Content 칸에 링크 텍스트로 페이지 버튼을 직접 만듭니다. 이미지를 넣어 자유롭게 꾸며도 됩니다.
- 사이드바를 맞춤형으로 설정하면, 기본으로 제공되는 사이드바의 페이지 버튼을 토글로 접을 수 있습니다.
- 사이드바를 다시 수정하려면, 사이드바 오른쪽 상단의 톱니바퀴 버튼을 클릭합니다.
- 맞춤형 설정을 해제하려면, 수정 페이지에서 Delete custom sidebar 버튼을 누릅니다.