• 단계 및 그룹 메타데이터
  • 예외
• 설명 메타데이터
• 추가 메타데이터
• TW 메타데이터의 일괄 업데이트
  • CODEOWNERS 파일 업데이트

메타데이터

각 문서 Markdown 페이지에는 YAML 프론트 매터가 포함되어 있습니다. 메타데이터의 모든 값은 문자열로 취급되며 문서 웹 사이트에만 사용됩니다.

단계 및 그룹 메타데이터

각 페이지에는 해당하는 단계 및 그룹과 관련된 메타데이터가 있어야 하며 정보 블록도 포함되어야 합니다. 예를 들어:

---
stage: 예제 단계
group: 예제 그룹
info: 이 페이지와 관련된 단계/그룹에 할당된 기술 작가를 확인하려면 https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments를 참조하세요.
---

메타데이터를 작성하려면 다음 정보를 포함하십시오:

• stage: 페이지의 대부분 내용이 속한 단계.
• group: 페이지의 대부분 내용이 속한 그룹.
• info: 페이지의 단계 및 그룹에 연결된 기술 작가를 찾는 방법.

예외

/development 디렉토리의 문서는 다음 메타데이터를 받습니다:

---
stage: 예제 단계
group: 예제 그룹
info: 최소한 Maintainer 역할을 가진 사용자는이 콘텐츠의 업데이트를 병합할 수 있습니다. 자세한 내용은 https://docs.gitlab.com/ee/development/development_processes.html#development-guidelines-review를 참조하세요.
---

/solutions 디렉토리의 문서는 다음 메타데이터를 받습니다:

---
stage: 솔루션 아키텍처
group: 솔루션 아키텍처
info: 이 페이지는 솔루션 아키텍처 팀에 의해 소유됩니다.
---

설명 메타데이터

description 태그는:

• 문서 홈페이지에 텍스트를 채우는 데 사용됩니다.
• 소셜 미디어 미리보기에 표시됩니다.
• 검색 결과 스니펫에 사용될 수 있습니다.

Use GitLab 및 한 단계 아래와 같은 최상위 페이지의 경우, 설명은 명사 목록입니다. 예를 들어 조직 설정의 경우, 설명은 사용자, 그룹, 네임스페이스, SSH 키.입니다.

다른 페이지의 경우, 설명은 적극적으로 유지되지 않습니다. 그러나 원하는 경우 페이지에 대한 간단한 설명을 추가하려면 Google 품질 메타 설명을 만드는 데 도움이 되는 모베스트(베스트?) 프랙티스를 참조하십시오.

추가 메타데이터

다음 메타데이터는 선택 사항이며 적극적으로 유지되지 않습니다.

• feedback: “도움말 및 피드백” 푸터에 포함되지 않도록 false로 설정합니다.
• noindex: 페이지가 검색 엔진에 의해 색인되는 것을 방지하려면 false로 설정합니다.
• redirect_to: 리디렉트를 제어하는 데 사용됩니다. 자세한 내용은 GitLab 문서에서 리디렉트를 참조하십시오.
• searchbar: 페이지 헤더에 검색 창을 포함시키지 않도록 false로 설정합니다.
• toc: “이 글에서” 탐색을 포함시키지 않도록 false로 설정합니다.

TW 메타데이터의 일괄 업데이트

CODEOWNERS 파일에는 파일 목록과 연결된 기술 작가가 포함되어 있습니다.

병합 요청에 문서가 포함된 경우 CODEOWNERS 파일의 정보가 다음을 결정합니다:

• 승인자 섹션의 사용자 목록.
• GitLab Bot이 커뮤니티 기여에 대해 기술 작가를 핑하는 방법.

Rake 작업을 사용하여 CODEOWNERS 파일을 업데이트할 수 있습니다.

CODEOWNERS 파일 업데이트

그룹 또는 TW assignments이 변경된 경우 CODEOWNERS 파일을 업데이트해야 합니다:

1. 영향을 받는 문서 페이지의 단계 및 그룹 메타데이터를 필요한 경우 업데이트합니다. 변경 사항이 많은 경우 이 단계를 별도의 MR에서 수행할 수 있습니다.
2. 변경된 내용을 반영하여 codeowners.rake 파일을 업데이트합니다.
3. gitlab 리포지토리의 루트로 이동합니다.
4. 다음 명령어로 Rake 작업을 실행합니다: bundle exec rake tw:codeowners
5. CODEOWNERS 파일의 변경 사항을 검토합니다.
6. 모든 변경 사항을 추가하고 커밋하고 브랜치를 origin에 푸시합니다.
7. 병합 요청을 만들고 기술 작성 관리자에게 할당합니다.

codeowners.rake 파일을 업데이트하는 경우:

• 단일 그룹에 대해 여러 작가를 지정하려면 작가 이름 사이에 공백을 사용합니다. 파일이 두 작가에게 모두 할당됩니다.

  CodeOwnerRule.new('그룹 이름', '@작가1 @작가2'),
  

  • 그룹 내 다른 디렉토리의 문서에 대해 그룹 내 다른 작가를 지정하려면 path 매개변수를 사용하여 디렉토리를 지정합니다:

    CodeOwnerRule.new('그룹 이름', ->(path) { path.start_with?('/doc/user') ? '@작가1' : '@작가2' }),
    

    이 예에서 작가1은 /doc/user에 관련된 파일의 코드 소유자입니다. 나머지 경우에는 작가2가 코드 소유자가됩니다. 예에 대한 내용은 MR 127903를 참조하십시오.

• 할당된 작가가 없는 그룹에 대해서는 파일에 그룹 이름을 포함하고 해당 줄을 주석 처리합니다:

  # CodeOwnerRule.new('그룹 이름', ''),