문서 사이트 아키텍처

GitLab 문서 웹사이트의 소스 파일 위치, 게시 방식, 버전 관리, 다국어 지원 등 전반적인 아키텍처를 설명합니다.

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 버전의 문서를 추가하거나 수정해야 하는 경우, 패치 릴리즈 런북 을 따르세요. 다른 리포지터리의 문서 # 기본 리포지터리 이외의 리포지터리에 코드와 문서가 있는 경우, 해당 리포지터리에서 코드와 함께 문서를 유지하는 것을 권장합니다. 그 후 다음 방법 중 하나를 사용할 수 있습니다: 권장. https://docs.gitlab.com 에 게시되는 제품 목록에 리포지터리를 추가 하세요. 문서 페이지의 소스는 외부 리포지터리에 그대로 남아 있지만, 생성된 페이지는 https://docs.gitlab.com 에서 색인화되고 검색됩니다. 권장. 해당 외부 리포지터리의 문서로 직접 연결되는 https://docs.gitlab.com 용 글로벌 내비게이션 항목을 추가 하세요. 문서 페이지는 https://docs.gitlab.com 에서 색인화되거나 검색되지 않습니다. gitlab 리포지터리에 해당 제품의 랜딩 페이지를 만들고, 랜딩 페이지를 글로벌 내비게이션에 추가 하되, 나머지 문서는 외부 리포지터리에 유지하세요. 랜딩 페이지는 https://docs.gitlab.com 에서 색인화 및 검색되지만, 나머지 문서는 그렇지 않습니다. 예를 들어 VS Code용 GitLab 확장 이 이에 해당합니다. 링크 목록 페이지 사용은 권장하지 않으므로, 권장 옵션이 불가능한 경우에만 이 방법을 사용하세요. 다른 언어의 문서 # GitLab 문서 번역은 반자율적인 프로세스로 진행됩니다. 영문 파일 이 공식 소스 파일이며, 번역본은 doc-locale 또는 유사한 경로 아래 언어별 하위 디렉터리에 위치합니다. 예를 들어 일본어 번역본은 /doc-locale/ja-j