롯데카드 · GitLab 도입 가이드 02. GitLab Wiki 기능 상세
CHAPTER 02 · 고객 문의 3번

02. GitLab Wiki 기능 상세

고객 문의 — GitLab Wiki 기능 상세 — 실제 데모 혹은 화면이라도 어떻게 구성되어 있는지 확인이 가능하면 좋겠습니다.

요약 답변

GitLab Wiki는 프로젝트·그룹 단위 문서 공간으로, Free 티어부터 모든 배포 형태에서 제공됩니다. 각 Wiki는 소스 저장소와 분리된 별도의 Git 저장소이므로 웹에서 편집하고, Git으로 clone해서 로컬에서 편집하고 둘 다 가능합니다. Markdown, AsciiDoc, RDoc, Org 형식을 지원하고, 페이지 계층, 사이드바, 목차, 변경 이력과 복원, PDF 내보내기, 템플릿, Mermaid·PlantUML 다이어그램을 지원합니다.

화면 흐름 (Siren Order 프로젝트에 실제 생성한 예시 Wiki)

이 데모를 위해 Siren Order 프로젝트에 예시 운영 문서 4개(Home, CI-CD 운영 가이드, 배포 전 점검표, 장애 대응 절차)를 실제로 만들었습니다. 아래 캡처는 그 생성 과정과 결과입니다.

02-1. 최초 진입 (빈 Wiki)

빈 Wiki 시작 화면
빈 Wiki 시작 화면
  • 위치: 프로젝트 > Plan > Wiki
  • 아직 페이지가 없으면 "Create your first page" 버튼이 보입니다. 첫 페이지는 반드시 home 경로를 사용하며 Wiki의 첫 화면이 됩니다.

02-2. Markdown 편집기

Wiki Markdown 편집기
Wiki Markdown 편집기
  • 제목과 본문을 입력하는 편집기입니다. 상단 툴 막대에서 굵게, 링크, 목록, 체크리스트, 코드 블록, 표, 파일·이미지 첨부, 다이어그램 삽입을 제공합니다.
  • 우측 상단의 "Switch to rich text editing"으로 위지윅 편집으로 전환할 수도 있습니다.
  • 본문의 [[페이지명]] 형식은 Wiki 내부 링크로 변환됩니다.

02-3. 미리보기

Wiki 미리보기
Wiki 미리보기
  • 저장 전 Preview로 렌더링 결과를 확인합니다. 표, 체크리스트, Mermaid 다이어그램이 실제 표시 형태로 나옵니다.

02-4. 생성된 Home 페이지

Wiki Home
Wiki Home
  • 저장 직후 화면입니다. 상단에 "Last edited by …, just now"가 표시되고, 페이지 하단에 댓글·리액션 영역이 있습니다.

02-5. 사이드바와 목차

Wiki 사이드바와 페이지 목차
Wiki 사이드바와 페이지 목차
  • 좌측 사이드바에 Wiki 페이지 목록이, 우측에는 현재 페이지의 헤딩 목차(On this page)가 자동 생성됩니다.
  • 사이드바는 _sidebar 페이지를 만들어 직접 커스터마이즈할 수 있습니다.

02-6. 두 번째 페이지: CI-CD 운영 가이드

CI-CD 운영 가이드 페이지
CI-CD 운영 가이드 페이지
  • 파이프라인 시작 조건 표, 표준 단계, 실패 처리 Mermaid 흐름도, 산출물 목록을 담은 운영 문서 예시입니다.

02-7. 세 번째 페이지: 배포 전 점검표

배포 전 점검표
배포 전 점검표
  • 변경 검토, 품질·보안, 배포·복구 체크리스트와 역할별 승인 기록 표 예시입니다.

02-8. 네 번째 페이지: 장애 대응 절차

장애 대응 절차
장애 대응 절차
  • 심각도 등급 표, 진단 절차, 복구 흐름도, 사후 분석 항목을 담은 페이지입니다.

02-9. 전체 페이지 목록

Wiki 페이지 목록
Wiki 페이지 목록
  • Wiki actions > View all pages에서 전체 페이지를 목록으로 확인합니다. 생성한 4개 페이지가 보입니다.

기능 상세 표

기능내용
지원 형식Markdown, AsciiDoc, RDoc, Org (파일 확장자로 구분)
저장 구조소스 저장소와 분리된 전용 Git 저장소 (프로젝트당 1개, 그룹 Wiki도 가능)
편집 경로웹 편집기(plain/rich text), Git clone 후 로컬 편집, API
링크[[페이지명]] Wiki 링크, 일반 Markdown 링크
목차헤딩 기반 자동 목차, [[_TOC_]] 태그로 본문 내 목차
사이드바기본 페이지 트리 + _sidebar로 커스텀 가능
템플릿templates/ 디렉터리의 Wiki 페이지를 새 페이지 템플릿으로 재사용
이력/복원Git 커밋 기반 변경 이력, 이전 버전 diff 확인과 복원
내보내기페이지를 PDF로 인쇄(내보내기) 가능
다이어그램Mermaid, PlantUML, Kroki, draw.io(diagrams.net) 연동
권한Developer 이상 생성·편집, 프로젝트 설정에서 Wiki on/off
알림페이지 단위 구독(댓글 알림)
페이지 경로/로 하위 경로 구성, 제목과 경로 분리(front matter) 지원

운영 활용 제안 (고객 설명용)

  • 운영 절차, 배포 점검, 장애 대응처럼 "코드와 함께 진화하는 문서"를 Wiki에 두면 변경 이력이 Git으로 추적되고, MR/이슈와 상호 링크됩니다.
  • Confluence를 사용 중이라면 외부 Wiki 연동(사이드바 링크)도 가능합니다.

공식 출처

  • Wiki: https://docs.gitlab.com/user/project/wiki/ (Tier: Free, Premium, Ultimate / Offering: GitLab.com, Self-Managed, Dedicated)