문서의 폴더 구조

GitLab 문서 리포지터리의 폴더 구조와 파일·디렉터리 작업 규칙, 문서 간 참조 방법을 설명합니다.

문서는 최상위 대상 폴더인 user , administration , development (기여) 폴더로 분리됩니다. 그 외에는 기본적으로 GitLab 사용자 인터페이스 또는 API의 구조를 따릅니다. 목표는 docs.gitlab.com/user/project/merge_requests/ 와 같이 의미 있는 URL을 가진 명확한 계층 구조를 갖추는 것입니다. 이 패턴을 통해 프로젝트 기능에 관한 사용자 관련 문서, 특히 머지 리퀘스트에 관한 내용으로 이동하고 있음을 즉시 알 수 있습니다. 사이트의 경로는 리포지터리의 경로와 일치하므로, 명확한 구조를 통해 문서를 더 쉽게 업데이트할 수 있습니다. 특정 제품 영역의 파일은 관련 폴더에 넣으세요: 디렉터리 내용 doc/user/ 사용자를 위한 문서. /admin 인터페이스 사용을 포함하여 GitLab 사용자 인터페이스에서 수행할 수 있는 모든 항목이 여기에 해당합니다. doc/administration/ GitLab이 설치된 서버에 접근할 수 있는 사용자가 필요한 문서. GitLab 사용자 인터페이스의 관리자 설정은 doc/administration/에 있습니다. doc/api/ API 관련 문서. doc/development/ 코드 또는 문서 기여 여부에 관계없이 GitLab 개발과 관련된 문서. 관련 프로세스 및 스타일 가이드도 여기에 포함됩니다. doc/legal/ GitLab 기여에 관한 법률 문서. doc/install/ GitLab 설치 지침. doc/update/ GitLab 업데이트 지침. doc/tutorials/ GitLab 사용 방법에 관한 튜토리얼. 다음은 레거시 또는 deprecated 폴더입니다. 이 폴더에는 새 콘텐츠를 추가하지 마세요: /gitlab-basics/ /topics/ /university/ 디렉터리 및 파일 작업 # 디렉터리 및 파일 작업 시: 새 디렉터리를 만들 때는 항상 _index.md 파일로 시작하세요. 다른 파일명을 사용하거나 README.md 파일을 만들지 마세요. 파일 이름, 디렉터리 이름, 브랜치 이름, 경로를 생성하는 모든 항목에 특수 문자, 공백 또는 대문자를 사용하지 마세요. 파일이나 디렉터리를 생성하거나 이름을 바꿀 때 이름에 두 단어 이상이 포함된 경우, 공백이나 밑줄 대신 대시( - )를 사용하세요 . 예를 들어, 올바른 이름 지정은 import-project/import-from-github.md 입니다. 이는 이미지 파일 과 Markdown 파일 모두에 적용됩니다. 제품 리포지터리에 비디오 파일을 업로드하지 마세요. 대신 비디오를 링크하거나 임베드하세요 . doc/user/ 디렉터리에서: doc/user/project/ 에는 프로젝트 관련 문서가 모두 포함되어야 합니다. doc/user/group/ 에는 그룹 관련 문서가 모두 포함되어야 합니다. doc/user/profile/ 에는 프로필 관련 문서가 모두 포함되어야 합니다. /profile 아래에서 탐색할 모든 페이지는 자체 문서를 가져야 합니다. 예: account.