문서 사이트 구조

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

자세한 내용은 gitlab-docs 아키텍처 페이지를 참조하세요.

소스 파일

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

문서 문제 및 병합 요청은 해당 리포지토리의 일부이며 모두 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 확장. 링크 목록이 있는 페이지를 사용하는 것을 권장하지 않으며, 따라서 권장 옵션이 실행 가능하지 않은 경우에만 이 옵션을 사용해야 합니다.

문서 웹사이트는 버전을 지원하며 매달 최신 버전을 목록에 추가합니다.

자세한 정보는 월간 릴리즈 프로세스를 읽어보세요.

GitLab은 코드 검토의 일부 요소를 위해 Danger를 사용합니다.

병합 요청의 문서 변경 사항에 대해 /doc 아래의 파일에 변경이 있을 때마다, Danger Bot은 문서 프로세스에 대한 추가 지침이 포함된 댓글을 남깁니다.

이는 GitLab 리포지토리의 Dangerfile에 구성되어 있습니다. /danger/documentation/에서 확인할 수 있습니다.

더 넓은 청중에게 도달하기 위해, 설문 조사 배너 요청을 할 수 있습니다.

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

설문 조사 배너를 요청하려면: