문서는 최상위 대상 폴더인 user, administration, development (기여) 폴더로 분리됩니다.

그 외에는 기본적으로 GitLab 사용자 인터페이스 또는 API의 구조를 따릅니다.

목표는 docs.gitlab.com/user/project/merge_requests/와 같이 의미 있는 URL을 가진 명확한 계층 구조를 갖추는 것입니다. 이 패턴을 통해 프로젝트 기능에 관한 사용자 관련 문서, 특히 머지 리퀘스트에 관한 내용으로 이동하고 있음을 즉시 알 수 있습니다. 사이트의 경로는 리포지터리의 경로와 일치하므로, 명확한 구조를 통해 문서를 더 쉽게 업데이트할 수 있습니다.

특정 제품 영역의 파일은 관련 폴더에 넣으세요:

다음은 레거시 또는 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.md, applications.md, emails.md.

• doc/administration/ 디렉터리에서: UI 및 백엔드 서버에서 수행하는 관리자 작업을 포함하여 관리자를 위한 모든 관리자 관련 문서.

문서 또는 콘텐츠 추가를 어디에 배치해야 할지 확실하지 않더라도, 작성 및 기여를 멈추지 마세요. 최선의 판단을 내리고, 머지 리퀘스트의 검토자에게 결정을 확인해 달라고 요청하세요. 또한 프로세스의 어느 단계에서든 기술 문서 작성자에게 질문할 수 있습니다. 기술 문서 작성 팀은 모든 문서 변경 사항을 검토하며, 더 적합한 위치가 있으면 콘텐츠를 이동할 수 있습니다.

가능한 경우 중복 방지#

가능한 경우 동일한 정보를 여러 위치에 포함하지 마세요. 대신 단일 진실 공급원(Single Source Of Truth, SSOT)에 링크하세요.

예를 들어 기본 리포지터리 이외의 리포지터리에 코드가 있고 동일한 리포지터리에 문서가 있는 경우, 해당 리포지터리에 문서를 유지할 수 있습니다.

그런 다음 다음 중 하나를 수행할 수 있습니다:

• https://docs.gitlab.com에 게시하세요.

• 전역 내비게이션에 항목을 추가하여 https://docs.gitlab.com에서 링크를 연결하세요.

문서 간 참조#

• 각 폴더에 해당 주제를 소개하고 하위 페이지(다음 레벨 하위 경로의 인덱스 페이지 포함)를 소개 및 링크하는 _index.md 페이지를 제공하세요.

• 검색 가능성을 보장하기 위해, 새 문서나 이름이 변경된 문서는 상위 레벨 인덱스 페이지 및 기타 관련 페이지에서 링크되도록 하세요.

• 다른 GitLab 제품 및 기능을 참조할 때는 최소한 첫 번째 언급 시 해당 문서로 링크하세요.

• 서드파티 제품이나 기술을 참조할 때는 해당 외부 사이트, 문서 및 리소스로 링크하세요.