문서 사이트 구조

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

더 많은 정보를 보려면 gitlab-docs 아키텍처 페이지를 확인하세요.

소스 파일

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

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

문서 관련 이슈 및 Merge Request은 각각의 리포지터리에 속하며 모두 Documentation 라벨이 붙어 있습니다.

게시

GitLab, GitLab Runner, GitLab Operator, Omnibus GitLab, Charts의 문서는 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 Workflow extension for VS Code. 링크 디렉터리을 포함하는 페이지의 사용을 장려하지 않습니다. 권장 사항이 적용 불가능한 경우에만 이 옵션을 사용하세요.

월간 릴리스 프로세스(버전)

문서 웹사이트는 버전을 지원하며 매월 최신 버전을 디렉터리에 추가합니다. 자세한 정보는 월간 릴리스 프로세스를 확인하세요.

Danger Bot

GitLab은 코드 리뷰의 일부 요소에 대해 Danger를 사용합니다. Merge Request에서 문서 변경이 발생하면 /doc 아래의 파일에 변경이 있을 때마다 Danger Bot이 문서 프로세스에 대한 추가 지침을 남깁니다. 이는 Dangerfile에서 구성됩니다.지 그 결과 페이지는 https://docs.gitlab.com에서 색인되어 검색됩니다. - 설문 배너 요청

더 넓은 대상층에 도달하려면 설문 배너를 요청할 수 있습니다.

동시에 한 개의 배너만 존재할 수 있습니다. 우선 순위는 먼저 요청한 사람에게 주어집니다.

설문 배너를 요청하려면:

gitlab-docs 프로젝트에서 이슈를 열고 “Survey banner request” 템플릿을 사용하세요.
이슈 설명에 세부 정보를 작성하세요.
이슈를 생성하면 기술 문서 팀의 누군가가 요청을 처리할 것입니다.
배너가 더 이상 필요하지 않을 때, 이슈에 할당된 사람에게 알리고 제거해 달라고 요청하세요.