글로벌 내비게이션

GitLab 문서 사이트의 글로벌 내비게이션 구조, 데이터 파일 형식, 레이아웃 구성, 항목 추가 방법을 설명합니다.

글로벌 내비게이션(global nav)은 문서의 가장 왼쪽 패널입니다. 글로벌 내비게이션을 사용하여 콘텐츠를 탐색할 수 있습니다. 연구에 따르면 사용자들은 GitLab 제품 문서를 검색할 때 Google을 사용합니다. 검색 결과 페이지에 도달했을 때, 사용자가 읽고 있는 콘텐츠와 관련된 주변 주제를 찾을 수 있도록 하는 것이 목표입니다. 글로벌 내비게이션은 이러한 정보를 제공합니다. 최상위 수준에서 글로벌 내비게이션은 워크플로 기반 입니다. 내비게이션은 사용자가 GitLab 사용 방법에 대한 정신적 모델을 구축하는 데 도움이 되어야 합니다. 각 상위 워크플로 기반 주제 아래의 레벨은 기능의 이름입니다. 예를 들면 다음과 같습니다: Use GitLab ( 워크플로 ) > Build your application ( 워크플로 ) > Get started ( 기능 ) > CI/CD ( 기능 ) > Pipelines ( 기능 ) 일부 오래된 내비게이션 섹션은 알파벳 순으로 되어 있지만, 내비게이션은 기본적으로 워크플로 기반이어야 합니다. 내비게이션 항목이 없으면: 페이지를 열 때 내비게이션이 닫히고, 독자는 현재 위치를 잃게 됩니다. 다른 페이지들과 함께 그룹에서 페이지를 볼 수 없습니다. 내비게이션 항목에 적합한 단어 선택 # 왼쪽 내비게이션에 항목을 추가하기 전에 사용할 품사를 선택하세요. 내비게이션 항목은 페이지 제목과 일치해야 합니다. 그러나 제목이 너무 길 경우 문구를 줄일 때 다음 중 하나를 사용하세요: Merge requests 와 같은 명사. Install GitLab 또는 Get started with runners 와 같은 능동형 동사. 페이지의 목적을 명확하게 나타내는 문구를 사용하세요. 예를 들어 Get started 는 Get started with runners 만큼 도움이 되지 않습니다. 내비게이션 항목 추가 # 글로벌 내비게이션은 gitlab-org/technical-writing/docs-gitlab-com 프로젝트의 data/en-us/navigation.yaml 파일에 저장되어 있습니다. docs.gitlab.com 의 문서 사이트는 Hugo를 사용하여 구축되며, 여러 프로젝트( charts , gitlab , gitlab-runner , omnibus-gitlab 등)의 문서 콘텐츠를 조합합니다. Technical Writer의 동의 없이 글로벌 내비게이션에 항목을 추가하지 마세요 . 글로벌 내비게이션에 주제를 추가하려면: https://docs.gitlab.com 에 해당 주제가 게시되어 있는지 확인합니다. navigation.yaml 파일에 항목을 추가합니다. 검토 및 병합을 위해 Technical Writer에게 MR을 할당합니다. 추가 위치 # 문서 페이지는 다음 그룹에 속한다고 볼 수 있습니다: GitLab 사용자. 이 문서는 Reporter부터 Owner까지 어떤 권한 수준의 사용자도 GitLab을 일상적으로 사용하기 위한 것입니다. GitLab 관리자. 이는 주로 GitLab을 호스팅하는 기반 인