GitLab 연동
화면 녹화본을 GitLab의 Markdown 문서로 변환
워크플로우를 한 번만 녹화하세요. Clevera가 이를 설명이 포함된 가이드로 작성하고, 스크린샷과 함께 Markdown 파일로 선택한 GitLab 프로젝트 및 폴더에 커밋합니다. 이제 다른 변경 사항과 마찬가지로 docs-as-code 파이프라인에서 바로 반영됩니다.
GitLab 스타일 Markdown
프로젝트에 커밋되는 스크린샷
GitLab Pages 및 MkDocs와 호환
게시 크레딧 무제한
활용 방법
문서 작성 없이도,
Docs as code를 실현하세요.
GitLab을 사용하는 팀은 이미 문서를 코드처럼 관리합니다. 프로젝트 내에 존재하고, 기록이 남으며, 파이프라인을 통해 게시되죠. 어려운 점은 파이프라인이 아니라 가이드를 작성하는 일이었습니다. Clevera는 화면 녹화본에서 가이드를 작성하고 파이프라인이 읽어올 폴더에 바로 저장합니다.
모든 워크플로우를 가이드로
기능을 한 번만 화면으로 보여주세요. Clevera가 녹화본을 번호가 매겨진 단계와 스크린샷이 포함된 문서로 변환하여 프로젝트 핸드북이나 제품 문서에 바로 사용할 수 있게 합니다.
나머지는 파이프라인이 처리
게시할 때마다 기본 브랜치에 일반적인 커밋이 생성되므로, GitLab Pages, MkDocs 또는 Hugo가 팀원의 변경 사항과 동일하게 사이트를 재빌드합니다.
프로젝트 내에 저장되는 이미지
스크린샷은 Markdown 파일 옆에 커밋되며 상대 경로로 연결됩니다. Clevera에 의존하지 않으며, 비공개 프로젝트에서는 이미지도 비공개로 유지됩니다.
읽기 쉬운 커밋으로 업데이트
Clevera에서 문서를 수정하고 다시 게시하세요. 동일한 파일과 이미지가 “Update article” 커밋으로 덮어쓰기 되어, 변경 내용과 시점을 기록에서 확인할 수 있습니다.
어떤 프로젝트든, 어떤 폴더든
연결된 계정이 Developer 이상의 권한을 가진 모든 GitLab 프로젝트를 선택하고 폴더를 입력하세요: docs, handbook/support 또는 프로젝트 루트.
브랜치 규칙 준수
Clevera는 보호된 브랜치 설정을 존중합니다. 만약 Maintainer만 main에 푸시할 수 있다면, Maintainer 계정을 연결하거나 Developer의 푸시 권한을 허용하세요.
작동 방식
녹화에서 GitLab 프로젝트까지,
4단계로 완료하세요.
소유자나 관리자가 GitLab을 한 번만 연결하면 됩니다. 그 이후에는 문서를 편집할 수 있는 누구나 에디터에서 바로 게시할 수 있습니다.
- 1
GitLab.com 연결
GitLab에 로그인하고 Clevera를 승인하세요. 계정이 Developer 이상의 권한을 가진 프로젝트 목록이 표시됩니다. - 2
Clevera가 가이드 작성
화면 녹화본을 바탕으로 Clevera가 제목, 번호가 매겨진 단계, 콜아웃, 스크린샷을 포함한 도움말 문서를 작성합니다. - 3
프로젝트 및 폴더 선택
Share 메뉴에서 Publish를 열고, GitLab 프로젝트와 폴더를 선택한 뒤 Publish to GitLab을 클릭하세요. - 4
커밋 완료
Markdown 파일과 이미지가 기본 브랜치에 하나의 커밋으로 도착하고 파이프라인이 실행됩니다.
Clevera에서 확인
GitLab으로 게시,
문서의 Share 창에서 바로 가능합니다.
내보내기나 수동 복사, 스크린샷을 저장소로 드래그할 필요가 없습니다. 링크와 임베드 코드를 제공하는 Share 창에서 바로 GitLab으로 커밋할 수 있습니다.
프로젝트와 폴더 선택
목록에는 연결된 GitLab 계정이 Developer 이상의 권한을 가진 프로젝트가 최근 업데이트순으로 표시됩니다. 문서가 위치할 폴더를 입력하세요 (예: docs/guides); 존재하지 않는 폴더는 동일한 커밋에서 생성됩니다.
Clevera는 프로젝트와 폴더를 기억하므로 다음 문서도 같은 위치로 게시됩니다.
중복 파일 없이 재게시
작성 전, Clevera는 해당 폴더에서 같은 이름의 파일을 찾습니다. 파일이 발견되면 새 커밋으로 덮어쓰거나, 유지하고 새 제목으로 게시할지 선택할 수 있습니다.
게시는 단방향입니다. GitLab에서 누군가 파일을 수정해도 Clevera 문서에는 반영되지 않습니다.
스택의 일부로 GitLab 활용
일부 팀은 제품 문서는 GitLab에, 사내 위키는 다른 곳에 보관합니다. 각 도구를 한 번씩 연결하고 같은 탭에서 GitLab, Confluence 또는 Notion 으로 게시하세요.
자동 완성
커밋에 포함되는 내용과
결정해야 할 사항들.
Clevera는 GitLab 파일 뷰에서 잘 보이고 정적 사이트 생성기에서 깔끔하게 빌드되는 Markdown을 작성합니다. 게시 시 프로젝트에 포함되는 내용은 다음과 같습니다.
- 프로젝트 및 폴더직접 선택
- 연결된 계정이 Developer 이상의 권한을 가진 모든 GitLab.com 프로젝트와 그 안의 모든 폴더. 폴더는
docs로 시작하며, 비워두면 프로젝트 루트가 됩니다. - 파일 이름자동 설정
- 문서 제목을 소문자와 하이픈으로 변환하고
.md를 붙입니다. “Reset a customer password”는reset-a-customer-password.md가 됩니다. 악센트나 비라틴 문자는 라틴 문자로 변환되며, 이름은 80자에서 잘립니다. - Front matter자동 설정
- 다음 정보를 포함한 YAML 블록:
title,created_at,updated_at및source. MkDocs, Hugo, Docusaurus는 제목을 읽고 나머지는 무시합니다. - 콜아웃 및 서식자동 변환
- 콜아웃은 GitLab 경고창으로 변환되며 제목이 같은 줄에 표시됩니다 (예:
> [!WARNING] Careful). 표, 작업 목록, 수식, 언어별 코드 블록, 접기 가능한<details>섹션은 GitLab 렌더링 방식 그대로 적용됩니다. - 스크린샷자동 설정
- 다음 경로에 커밋:
assets/<file name>/동일한 폴더, 동일한 커밋 내에 저장되며, 각 캡션은 이미지 아래에 이탤릭체로 표시됩니다. - 커밋자동 설정
- 기본 브랜치에 하나의 커밋으로 생성되며 메시지는
Add article: …또는Update article: …이며, Clevera를 연결한 GitLab 계정 명의로 작성됩니다. - 동영상자동 설정
- 문서 내 동영상은 플레이어로 연결되는 포스터 이미지와 제목이 포함된 ▶ 링크로 변환됩니다. 원본 녹화 파일은 추가되지 않습니다.
설정
GitLab 연동 설정
약 2분 소요.
Clevera Pro 또는 Custom 워크스페이스와 GitLab.com 계정이 필요합니다. 워크스페이스 소유자나 관리자가 GitLab을 연결하면, 이후 문서를 편집할 수 있는 누구나 게시할 수 있습니다. 게시 시 크레딧은 차감되지 않습니다.
- 1
Integrations 열기
Clevera에서 워크스페이스 메뉴를 열고 Integrations를 선택한 뒤, Code repositories 에서 GitLab을 찾아 Connect. - 2
GitLab.com에서 Clevera 승인
GitLab은 api, read_user, read_repository 및 write_repository 범위를 요청하며, 이는 파일 API가 파일을 생성하고 업데이트하는 데 필요합니다. Authorize. - 3
권한 확인
각 프로젝트에서 Developer 이상의 권한을 가진 계정을 사용하세요. 보호된 기본 브랜치에 커밋하려면 일반적으로 Maintainer권한이 필요합니다. 공유 봇 계정을 사용하는 것도 좋은 방법입니다. - 4
문서 게시
문서 에디터에서 Share를 클릭하고 Publish를 연 뒤, GitLab 타일을 선택하고 프로젝트와 폴더를 지정한 후 Publish to GitLab. - 5
GitLab에서 열기
“Published to GitLab.” 메시지가 보이면 Open in GitLab 을 클릭하여 파일과 커밋을 확인하세요.
GitLab 연동 관련 질문
아니요. Clevera는 GitLab.com만 지원합니다. 자체 호스팅 GitLab 서버는 지원하지 않으므로, 직접 구축한 GitLab 인스턴스의 프로젝트는 게시 대상으로 사용할 수 없습니다.
아니요. Clevera는 프로젝트의 기본 브랜치(보통 main)에 직접 커밋하며, 다른 브랜치를 선택할 수 없습니다. 팀에서 Merge Request를 통해 문서를 검토한다면 게시 전 Clevera에서 문서를 검토하거나, 직접 커밋이 허용된 프로젝트에 게시하세요.
대부분 보호된 브랜치 때문입니다. GitLab은 기본 브랜치를 보호하며 일반적으로 Maintainer만 푸시할 수 있게 합니다. 연결된 계정에 Maintainer 권한을 부여하거나 Settings → Repository → Protected branches.
GitLab Pages, MkDocs, Hugo로 게시할 수 있나요? title 네. 사이트가 빌드되는 폴더를 지정하세요. 게시할 때마다 일반 커밋이 생성되므로 CI/CD 파이프라인이 정상적으로 실행되며, 생성기가 front matter에서
다시 게시하기 전까지 GitLab의 내용은 변경되지 않습니다. 게시 시 Clevera가 기존 파일을 찾아 새 커밋으로 업데이트할 수 있게 해줍니다. 아티클 이름을 변경하면 새 제목으로 파일이 생성되므로, 이전 파일은 GitLab에서 직접 삭제해야 합니다. Clevera는 프로젝트에서 파일을 절대 삭제하지 않습니다.
워크스페이스당 하나의 GitLab 연결만 가능하며, 다시 연결하면 기존 연결이 대체됩니다. 게시하려는 모든 프로젝트의 멤버인 계정을 사용하세요.
GitLab 게시 기능은 Pro 및 Custom 플랜에서 제공되며, 게시 시 크레딧은 차감되지 않습니다. 아티클을 생성할 때는 평소처럼 크레딧이 사용됩니다. 다음을 확인하세요. 요금제.