문서 사이트 구조

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

더 많은 정보는 gitlab-docs 구조 페이지를 참조하세요.

소스 파일

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

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

문서 이슈 및 병합 요청은 해당 리포지토리에 속하며 모두 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에서 색인 및 검색 가능하지만 나머지 문서는 그렇지 않습니다. 예를 들어 VS Code용 GitLab Workflow 확장 프로그램. 링크 목록 페이지의 사용을 권장하지 않으며, 권장되는 옵션이 불가능한 경우에만 이 옵션을 사용하세요.

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

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

Danger Bot

GitLab은 코드 리뷰에서 일부 요소에 대해 Danger를 사용합니다. 병합 요청의 문서 변경 시 /doc 하위 파일을 변경할 때마다 Danger Bot이 문서 프로세스에 대한 자세한 지침이 포함된 댓글을 남깁니다. 이는 GitLab 리포지토리의 Dangerfile에서 /danger/documentation/에 구성됩니다.

문서 설문 배너 요청

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

한 번에 한 배너만 존재할 수 있습니다. 누가 처음으로 배너를 요청했는지에 따라 우선 순위가 결정됩니다.

문서 설문 배너를 요청하려면:

gitlab-docs 프로젝트에서 이슈를 엽니다 및 “Survey banner request” 템플릿을 사용하세요.
이슈 설명에 세부 정보를 입력하세요.
이슈를 만들고 기술 문서 팀의 구성원 중 한 명이 요청을 처리할 것입니다.
배너가 더 이상 필요하지 않은 경우 담당자에게 알리고 제거해달라고 요청하세요.