문서 사이트 아키텍처

요약

docs-gitlab-com 프로젝트는 GitLab 문서 웹사이트를 생성하는 데 사용하는 리포지터리를 호스팅하며, https://docs.gitlab.com에 배포됩니다. 자세한 내용은 문서 사이트 아키텍처 페이지를 참고합니다.

docs-gitlab-com 프로젝트는 GitLab 문서 웹사이트를 생성하는 데 사용하는 리포지터리를 호스팅하며, https://docs.gitlab.com에 배포됩니다. Hugo 정적 사이트 생성기를 사용합니다.

자세한 내용은 문서 사이트 아키텍처 페이지를 참고합니다.

소스 파일#

문서 소스 파일은 제품 코드와 같은 리포지터리에 있습니다.

프로젝트	경로
GitLab	`/doc`
GitLab Runner	`/docs`
Omnibus GitLab	`/doc`
Charts	`/doc`
GitLab Operator	`/doc`
GitLab CLI (glab)	`/docs/source`
Artifact Registry	`/docs`
Orbit	`/docs`

문서 이슈와 머지 리퀘스트는 각 리포지터리에 속하며 모두 Documentation 레이블이 붙어 있습니다.

게시#

GitLab, GitLab Runner, GitLab Operator, Omnibus GitLab, Charts, GitLab Orbit, Artifact Registry의 문서는 https://docs.gitlab.com에 게시됩니다.

동일한 문서가 애플리케이션에도 포함되어 있습니다. 제품 내 도움말을 보려면 해당 URL 끝에 /help를 붙입니다. 현재 사용 중인 에디션과 버전의 도움말만 포함됩니다.

다른 버전의 도움말은 https://docs.gitlab.com/archives/에서 볼 수 있습니다.

이전 버전 업데이트#

이미 릴리스된 GitLab 버전의 문서를 추가하거나 수정해야 한다면 패치 릴리스 런북을 따릅니다.

다른 리포지터리의 문서#

기본 리포지터리가 아닌 리포지터리에 코드와 문서가 있다면, 그 리포지터리에서 문서를 코드와 함께 관리합니다.

그런 다음 다음 중 한 가지 방법을 사용할 수 있습니다.

권장 방법입니다. https://docs.gitlab.com에 게시되는 제품 목록에 해당 리포지터리를 추가합니다. 문서 페이지의 소스는 외부 리포지터리에 남지만, 생성된 페이지는 https://docs.gitlab.com에서 색인되고 검색됩니다.
권장 방법입니다. 해당 외부 리포지터리의 문서로 직접 연결되도록 https://docs.gitlab.com의 전역 내비게이션에 항목을 추가합니다. 이 문서 페이지는 https://docs.gitlab.com에서 색인되거나 검색되지 않습니다.
gitlab 리포지터리에 해당 제품의 랜딩 페이지를 만들고 그 랜딩 페이지를 전역 내비게이션에 추가하되, 나머지 문서는 외부 리포지터리에 둡니다. 랜딩 페이지는 https://docs.gitlab.com에서 색인되고 검색되지만, 나머지 문서는 그렇지 않습니다. GitLab for VS Code extension이 그러한 예입니다. 링크 목록으로만 이루어진 페이지는 권장하지 않으므로, 권장 방법을 적용할 수 없을 때만 이 방법을 사용합니다.

다른 언어의 문서#

GitLab 문서의 번역은 준자동화된 절차로 진행됩니다. 영어 파일이 정본 소스 파일이며, 번역본은 doc-locale 또는 유사한 경로 아래 언어별 하위 디렉터리에 있습니다. 예를 들어 일본어 번역본은 /doc-locale/ja-jp/에 있습니다.

프로젝트	경로
GitLab	`/doc-locale`
GitLab Runner	`/docs-locale`
Omnibus GitLab	`/doc-locale`
Charts	`/doc-locale`
GitLab Operator	`/doc-locale`

doc/development 또는 유사한 경로의 개발 문서는 번역하지 않습니다.

기여는 영어 소스 파일에만 할 수 있습니다. 번역 파일은 자동화로 갱신됩니다.

월별 릴리스 프로세스(버전)#

문서 웹사이트는 버전을 지원하며 매월 최신 버전을 목록에 추가합니다. 자세한 내용은 월별 릴리스 프로세스를 참고합니다.

Danger Bot#

GitLab은 코드 리뷰 프로세스를 자동화하는 데 Danger를 사용합니다. 머지 리퀘스트에서 /doc의 문서 파일이 수정되면 Danger Bot 이 문서 관련 가이드라인을 자동으로 댓글로 남깁니다. 이 자동화는 Dangerfile에 구성되어 있습니다.

문서 설문 배너 요청#

더 많은 독자에게 도달하기 위해 설문 배너를 요청할 수 있습니다.

배너는 한 번에 하나만 존재할 수 있습니다. 우선순위는 배너를 먼저 요청한 순서에 따라 정해집니다.

설문 배너를 요청하는 방법은 다음과 같습니다.

docs-gitlab-com 프로젝트에서 이슈를 엽니다. 이때 "Survey banner request" 템플릿을 사용합니다.
이슈 설명에 세부 내용을 입력합니다.
이슈를 생성하면 Technical Writing 팀의 담당자가 요청을 처리합니다.
배너가 더 이상 필요하지 않으면 이슈 담당자에게 알려 제거를 요청합니다.