InfoGrab DocsInfoGrab Docs

문서 사이트 아키텍처

요약

docs-gitlab-com 프로젝트는 GitLab 문서 웹사이트를 생성하는 데 사용되는 리포지터리를 호스팅하며, https://docs.gitlab.com에 배포됩니다. 자세한 내용은 Docs site architecture 페이지를 참조하세요.

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

자세한 내용은 Docs site architecture 페이지를 참조하세요.

소스 파일#

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

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

문서 이슈와 머지 리퀘스트는 각 리포지터리에 속하며, 모두 Documentation 라벨을 가집니다.

게시#

GitLab, GitLab Runner, GitLab Operator, Omnibus GitLab, Charts에 대한 문서는 https://docs.gitlab.com에 게시됩니다.

동일한 문서가 애플리케이션에도 포함됩니다. 제품 내 도움말을 보려면 URL 끝에 /help를 추가하세요. 현재 에디션 및 버전에 해당하는 도움말만 포함됩니다.

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

이전 버전 업데이트#

이미 릴리즈된 GitLab 버전의 문서를 추가하거나 수정해야 하는 경우, 패치 릴리즈 런북을 따르세요.

다른 리포지터리의 문서#

기본 리포지터리 이외의 리포지터리에 코드와 문서가 있는 경우, 해당 리포지터리에서 코드와 함께 문서를 유지하는 것을 권장합니다.

그 후 다음 방법 중 하나를 사용할 수 있습니다:

다른 언어의 문서#

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 팀의 누군가가 요청을 처리합니다.

  • 배너가 더 이상 필요하지 않으면, 이슈에 할당된 담당자에게 핑(ping)을 보내 배너를 제거해 달라고 요청하세요.

문서 사이트 아키텍처

GitLab v19.1
원문 보기
요약

docs-gitlab-com 프로젝트는 GitLab 문서 웹사이트를 생성하는 데 사용되는 리포지터리를 호스팅하며, https://docs.gitlab.com에 배포됩니다. 자세한 내용은 Docs site architecture 페이지를 참조하세요.

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

자세한 내용은 Docs site architecture 페이지를 참조하세요.

소스 파일#

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

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

문서 이슈와 머지 리퀘스트는 각 리포지터리에 속하며, 모두 Documentation 라벨을 가집니다.

게시#

GitLab, GitLab Runner, GitLab Operator, Omnibus GitLab, Charts에 대한 문서는 https://docs.gitlab.com에 게시됩니다.

동일한 문서가 애플리케이션에도 포함됩니다. 제품 내 도움말을 보려면 URL 끝에 /help를 추가하세요. 현재 에디션 및 버전에 해당하는 도움말만 포함됩니다.

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

이전 버전 업데이트#

이미 릴리즈된 GitLab 버전의 문서를 추가하거나 수정해야 하는 경우, 패치 릴리즈 런북을 따르세요.

다른 리포지터리의 문서#

기본 리포지터리 이외의 리포지터리에 코드와 문서가 있는 경우, 해당 리포지터리에서 코드와 함께 문서를 유지하는 것을 권장합니다.

그 후 다음 방법 중 하나를 사용할 수 있습니다:

다른 언어의 문서#

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 팀의 누군가가 요청을 처리합니다.

  • 배너가 더 이상 필요하지 않으면, 이슈에 할당된 담당자에게 핑(ping)을 보내 배너를 제거해 달라고 요청하세요.