GitLab /help

GitLab 인스턴스의 /help 페이지 동작 방식, 페이지 매핑 규칙, 그리고 애플리케이션에서 /help에 링크하는 방법을 설명합니다.

모든 GitLab 인스턴스는 해당 인스턴스의 버전에 맞는 문서를 /help ( https://gitlab.example.com/help )에서 제공합니다. 예를 들어 https://gitlab.com/help 에서 확인할 수 있습니다. https://docs.gitlab.com 에서 온라인으로 제공되는 문서는 GitLab, Omnibus, Runner, Charts, Operator의 기본 브랜치에서 매 시간 배포됩니다. 문서를 업데이트하는 머지 리퀘스트가 병합되면, 한 시간 이내에 온라인에서 확인할 수 있습니다. 그러나 GitLab Self-Managed 인스턴스의 /help 에서는 다음 릴리즈 버전에서야 업데이트가 반영됩니다. 업데이트가 병합된 날짜에 따라 해당 업데이트가 어떤 GitLab Self-Managed 릴리즈에 포함되는지가 달라질 수 있습니다. 예를 들어: gitlab 의 머지 리퀘스트가 문서를 업데이트합니다. 이 머지 리퀘스트의 마일스톤은 14.4이며, 예상 릴리즈 날짜는 2021-10-22입니다. 2021-10-19에 병합되어 당일 https://docs.gitlab.com 에서 온라인으로 확인할 수 있습니다. GitLab 14.4는 2021-10-18(업데이트가 병합되기 하루 전)의 gitlab 코드베이스를 기준으로 2021-10-22에 릴리즈됩니다. 14.4의 릴리즈 컷오프를 놓쳤기 때문에, 해당 변경 사항은 14.5 GitLab Self-Managed 릴리즈에 반영됩니다. 문서 업데이트를 해당 월의 릴리즈에 포함시키는 것이 중요하다면, 가능한 한 일찍 병합하세요. 페이지 매핑 # /help 에 대한 요청은 리디렉션 될 수 있습니다. 리디렉션이 꺼져 있는 경우, /help 는 도움말 페이지 요청을 doc 디렉터리의 특정 파일에 매핑합니다. 예를 들어: 요청된 URL: <gdk_instance>/help/topics/plan_and_track.md , <gdk_instance>/help/topics/plan_and_track.html 및 <gdk_instance>/help/topics/plan_and_track . 매핑: doc/topics/plan_and_track.md . _index.md 파일 # 히스토리 GitLab 16.10에서 _index.md 파일 지원이 도입됨 . Hugo 정적 사이트 생성기는 _index.md 파일을 활용합니다. /help 에서 인덱스 페이지 이름이 index.md 이든 _index.md 이든 허용하기 위해, GitLab은 index.md , index.html , 또는 index 에 대한 요청을 다음과 같이 매핑합니다: 요청된 위치에 파일이 존재하면 index.md 로 매핑합니다. 그렇지 않으면 _index.md 로 매핑합니다. 예를 들어: 요청된 URL: <gdk_instance>/help/user/index.md , <gdk_instance>/help/user/index.html , 및 <gdk_instance>/help/use