문서 사이트 아키텍처

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” 템플릿을 사용합니다.
이슈 설명란에 세부 정보를 기입합니다.
이슈를 생성하면 기술 문서 작성팀에서 요청을 처리할 것입니다.
배너가 더 이상 필요하지 않은 경우, 이슈에 할당된 담당자에게 ping을 보내어 제거해 달라고 요청합니다.