InfoGrab DocsInfoGrab Docs

메타데이터

요약

각 문서 Markdown 페이지에는 YAML 프론트매터가 포함되어 있습니다. 각 페이지에는 해당 페이지가 속한 Stage 및 그룹과 관련된 메타데이터, 정보 블록, 페이지 제목이 있어야 합니다. 메타데이터를 작성할 때는 다음 정보를 포함하세요:

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

Stage 및 그룹 메타데이터#

각 페이지에는 해당 페이지가 속한 Stage 및 그룹과 관련된 메타데이터, 정보 블록, 페이지 제목이 있어야 합니다. 예를 들면:

---
stage: Example Stage
group: Example Group
info: To determine the technical writer assigned to the Stage/Group associated with this page, see <https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments>
title: Example page title
---

메타데이터를 작성할 때는 다음 정보를 포함하세요:

  • stage: 페이지 콘텐츠의 대부분이 속하는 Stage

  • group: 페이지 콘텐츠의 대부분이 속하는 그룹

  • info: 페이지의 Stage 및 그룹과 관련된 Technical Writer를 찾는 방법

  • title: 페이지 상단에 H1(1단계 제목)으로 표시되는 페이지 제목

예외 사항#

/development 디렉터리의 문서에는 다음 메타데이터를 사용합니다:

---
stage: Example Stage
group: Example Group
info: Any user with at least the Maintainer role can merge updates to this content. For details, see <https://docs.gitlab.com/development/development_processes/#development-guidelines-review>.
title: Example page title
---

/solutions 디렉터리의 문서에는 다음 메타데이터를 사용합니다:

---
stage: Solutions Architecture
group: Solutions Architecture
info: This page is owned by the Solutions Architecture team.
title: Example page title
---

미할당 페이지#

명확한 그룹 소유자가 없는 문서는 *미할당(unassigned)*으로 간주되며 다음 메타데이터를 사용합니다:

---
stage: none
group: unassigned
info: For assistance with this Style Guide page, see <https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects>.
title: Example page title
---

메타데이터가 유효한 YAML로 유지되는 한, stage와 group에 추가 정보를 포함할 수 있습니다.

제목 메타데이터#

title 메타데이터는:

  • 렌더링된 페이지 상단에 H1(1단계 제목)을 생성합니다.

  • 자동화된 페이지 목록 생성에 사용될 수 있습니다.

  • Markdown H1 제목(예: # Page title)을 대체합니다.

설명 메타데이터#

description 태그는:

  • 문서 홈 페이지의 텍스트를 채우는 데 사용됩니다.

  • 소셜 미디어 미리보기에 표시됩니다.

  • 검색 결과 스니펫에 사용될 수 있습니다.

  • cards 단축 코드에 페이지가 포함될 때 표시됩니다.

Use GitLab 및 그 하위 한 단계와 같은 최상위 페이지의 경우, 설명은 능동형 동사로 시작하는 짧은 문장이어야 합니다. 설명은 사용자가 해당 페이지에서 찾을 수 있는 정보와 페이지를 방문하는 가치를 명확히 전달해야 합니다.

다른 페이지의 경우, 페이지 내용에 대한 짧은 설명을 사용하세요:

전체 내비게이션에 페이지가 추가되지 않도록 설정#

특정 페이지가 전체 내비게이션에 추가되지 않아야 하는 경우(즉, navigation.yaml에 항목이 추가되지 않아야 하는 경우), 페이지 메타데이터에 다음을 추가하세요:

ignore_in_report: true

이 메타데이터가 페이지에 설정되면:

  • pages_not_in_nav.cjs 스크립트가 문서를 처리할 때 해당 페이지를 무시합니다.

  • Technical Writing 팀의 월간 작업을 수행하는 Technical Writer에게 해당 페이지를 전체 내비게이션에 추가하라는 안내가 표시되지 않습니다.

GitLab Dedicated 지원 표시#

gitlab_dedicated 메타데이터는 문서 페이지가 GitLab Dedicated에 적용되는지 여부를 나타냅니다.

GitLab Dedicated 사용 가능 여부가 제품 팀과 확인된 경우, 해당 문서 페이지에 이 필드를 추가하세요. 이 메타데이터는 Offering 상세 정보를 보완하는 것이며 대체하는 것이 아닙니다.

예를 들어, 일반적으로 GitLab Self-Managed에 적용되는 페이지는 GitLab Dedicated에도 적용됩니다. 적용되지 않는 경우 이 메타데이터를 사용하세요:

gitlab_dedicated: no

페이지가 GitLab Dedicated에 적용되는 경우 다음을 사용하세요:

gitlab_dedicated: yes

GitLab Dedicated에서 부분적으로 사용 가능한 페이지의 경우, gitlab_dedicated: yes를 사용하고 GitLab Dedicated에 적용되지 않는 주제에 대해 제품 사용 가능성 상세 정보를 업데이트하세요.

제품 사용 가능성 상세 정보 미포함 표시#

의도적으로 사용 가능성 상세 정보가 없는 페이지의 경우, 페이지 상단에 다음 메타데이터를 추가하세요:

availability_details: no

추가 메타데이터#

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

  • feedback: 이 페이지가 도움이 되었나요? 피드백 위젯을 제외하려면 false로 설정합니다.

  • noindex: 검색 엔진이 페이지를 인덱싱하지 않도록 방지하려면 true로 설정합니다.

  • redirect_to: 리다이렉트를 제어하는 데 사용됩니다. 자세한 내용은 GitLab 문서의 리다이렉트를 참조하세요.

  • toc: 오른쪽 내비게이션을 제외하려면 false로 설정합니다.

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

CODEOWNERS 파일에는 파일 목록과 관련 Technical Writer가 포함되어 있습니다.

머지 리퀘스트에 문서가 포함된 경우, CODEOWNERS 파일의 정보에 따라 다음이 결정됩니다:

  • Approvers 섹션의 사용자 목록

  • GitLab Bot이 커뮤니티 기여에 대해 핑(ping)하는 Technical Writer

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

CODEOWNERS 파일 업데이트#

그룹 또는 TW 할당이 변경되면 CODEOWNERS 파일을 업데이트해야 합니다. 이를 위해 codeowners.rake Rake 작업을 실행합니다.

이 작업은:

  • doc 디렉터리의 모든 파일을 확인합니다.

  • 메타데이터에서 group 값을 읽습니다. group의 값이 Rake 작업에 알려지지 않은 경우 해당 페이지는 Technical Writer에게 할당되지 않은 것으로 처리됩니다.

  • codeowners.rake 파일의 정보를 사용하여 CODEOWNERS 파일을 채웁니다.

CODEOWNERS 파일을 업데이트하려면:

  • 필요한 경우 영향을 받는 문서 페이지의 Stage 및 그룹 메타데이터를 업데이트합니다. 변경 사항이 많은 경우, 별도의 머지 리퀘스트에서 이 단계를 수행할 수 있습니다.

  • codeowners.rake 파일을 변경 사항으로 업데이트합니다.

  • gitlab 리포지터리 루트로 이동합니다.

  • 다음 명령어로 Rake 작업을 실행합니다: bundle exec rake tw:codeowners

  • CODEOWNERS 파일의 변경 사항을 검토합니다.

  • 모든 변경 사항을 추가하고 커밋한 후 브랜치를 origin으로 푸시합니다.

  • 머지 리퀘스트를 생성하고 Technical Writing 매니저에게 리뷰를 할당합니다.

codeowners.rake 파일을 업데이트할 때:

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

CodeOwnerRule.new('Group Name', '@writer1 @writer2'),

그룹 내 서로 다른 디렉터리의 문서에 다른 작성자를 할당하려면, path 매개변수를 사용하여 디렉터리를 지정합니다:

CodeOwnerRule.new('Group Name', ->(path) { path.start_with?('/doc/user') ? '@writer1' : '@writer2' }),

이 예시에서 writer1은 /doc/user에 있는 이 그룹과 관련된 파일의 코드 Owner입니다. 그 외 모든 파일에 대해서는 writer2가 코드 Owner로 지정됩니다. 예시는 MR 127903을 참조하세요.

할당된 작성자가 없는 그룹의 경우, 파일에 그룹 이름을 포함하고 해당 줄을 주석 처리합니다:

# CodeOwnerRule.new('Group Name', ''),

메타데이터

GitLab v19.1
원문 보기
요약

각 문서 Markdown 페이지에는 YAML 프론트매터가 포함되어 있습니다. 각 페이지에는 해당 페이지가 속한 Stage 및 그룹과 관련된 메타데이터, 정보 블록, 페이지 제목이 있어야 합니다. 메타데이터를 작성할 때는 다음 정보를 포함하세요:

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

Stage 및 그룹 메타데이터#

각 페이지에는 해당 페이지가 속한 Stage 및 그룹과 관련된 메타데이터, 정보 블록, 페이지 제목이 있어야 합니다. 예를 들면:

---
stage: Example Stage
group: Example Group
info: To determine the technical writer assigned to the Stage/Group associated with this page, see <https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments>
title: Example page title
---

메타데이터를 작성할 때는 다음 정보를 포함하세요:

  • stage: 페이지 콘텐츠의 대부분이 속하는 Stage

  • group: 페이지 콘텐츠의 대부분이 속하는 그룹

  • info: 페이지의 Stage 및 그룹과 관련된 Technical Writer를 찾는 방법

  • title: 페이지 상단에 H1(1단계 제목)으로 표시되는 페이지 제목

예외 사항#

/development 디렉터리의 문서에는 다음 메타데이터를 사용합니다:

---
stage: Example Stage
group: Example Group
info: Any user with at least the Maintainer role can merge updates to this content. For details, see <https://docs.gitlab.com/development/development_processes/#development-guidelines-review>.
title: Example page title
---

/solutions 디렉터리의 문서에는 다음 메타데이터를 사용합니다:

---
stage: Solutions Architecture
group: Solutions Architecture
info: This page is owned by the Solutions Architecture team.
title: Example page title
---

미할당 페이지#

명확한 그룹 소유자가 없는 문서는 *미할당(unassigned)*으로 간주되며 다음 메타데이터를 사용합니다:

---
stage: none
group: unassigned
info: For assistance with this Style Guide page, see <https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects>.
title: Example page title
---

메타데이터가 유효한 YAML로 유지되는 한, stage와 group에 추가 정보를 포함할 수 있습니다.

제목 메타데이터#

title 메타데이터는:

  • 렌더링된 페이지 상단에 H1(1단계 제목)을 생성합니다.

  • 자동화된 페이지 목록 생성에 사용될 수 있습니다.

  • Markdown H1 제목(예: # Page title)을 대체합니다.

설명 메타데이터#

description 태그는:

  • 문서 홈 페이지의 텍스트를 채우는 데 사용됩니다.

  • 소셜 미디어 미리보기에 표시됩니다.

  • 검색 결과 스니펫에 사용될 수 있습니다.

  • cards 단축 코드에 페이지가 포함될 때 표시됩니다.

Use GitLab 및 그 하위 한 단계와 같은 최상위 페이지의 경우, 설명은 능동형 동사로 시작하는 짧은 문장이어야 합니다. 설명은 사용자가 해당 페이지에서 찾을 수 있는 정보와 페이지를 방문하는 가치를 명확히 전달해야 합니다.

다른 페이지의 경우, 페이지 내용에 대한 짧은 설명을 사용하세요:

전체 내비게이션에 페이지가 추가되지 않도록 설정#

특정 페이지가 전체 내비게이션에 추가되지 않아야 하는 경우(즉, navigation.yaml에 항목이 추가되지 않아야 하는 경우), 페이지 메타데이터에 다음을 추가하세요:

ignore_in_report: true

이 메타데이터가 페이지에 설정되면:

  • pages_not_in_nav.cjs 스크립트가 문서를 처리할 때 해당 페이지를 무시합니다.

  • Technical Writing 팀의 월간 작업을 수행하는 Technical Writer에게 해당 페이지를 전체 내비게이션에 추가하라는 안내가 표시되지 않습니다.

GitLab Dedicated 지원 표시#

gitlab_dedicated 메타데이터는 문서 페이지가 GitLab Dedicated에 적용되는지 여부를 나타냅니다.

GitLab Dedicated 사용 가능 여부가 제품 팀과 확인된 경우, 해당 문서 페이지에 이 필드를 추가하세요. 이 메타데이터는 Offering 상세 정보를 보완하는 것이며 대체하는 것이 아닙니다.

예를 들어, 일반적으로 GitLab Self-Managed에 적용되는 페이지는 GitLab Dedicated에도 적용됩니다. 적용되지 않는 경우 이 메타데이터를 사용하세요:

gitlab_dedicated: no

페이지가 GitLab Dedicated에 적용되는 경우 다음을 사용하세요:

gitlab_dedicated: yes

GitLab Dedicated에서 부분적으로 사용 가능한 페이지의 경우, gitlab_dedicated: yes를 사용하고 GitLab Dedicated에 적용되지 않는 주제에 대해 제품 사용 가능성 상세 정보를 업데이트하세요.

제품 사용 가능성 상세 정보 미포함 표시#

의도적으로 사용 가능성 상세 정보가 없는 페이지의 경우, 페이지 상단에 다음 메타데이터를 추가하세요:

availability_details: no

추가 메타데이터#

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

  • feedback: 이 페이지가 도움이 되었나요? 피드백 위젯을 제외하려면 false로 설정합니다.

  • noindex: 검색 엔진이 페이지를 인덱싱하지 않도록 방지하려면 true로 설정합니다.

  • redirect_to: 리다이렉트를 제어하는 데 사용됩니다. 자세한 내용은 GitLab 문서의 리다이렉트를 참조하세요.

  • toc: 오른쪽 내비게이션을 제외하려면 false로 설정합니다.

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

CODEOWNERS 파일에는 파일 목록과 관련 Technical Writer가 포함되어 있습니다.

머지 리퀘스트에 문서가 포함된 경우, CODEOWNERS 파일의 정보에 따라 다음이 결정됩니다:

  • Approvers 섹션의 사용자 목록

  • GitLab Bot이 커뮤니티 기여에 대해 핑(ping)하는 Technical Writer

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

CODEOWNERS 파일 업데이트#

그룹 또는 TW 할당이 변경되면 CODEOWNERS 파일을 업데이트해야 합니다. 이를 위해 codeowners.rake Rake 작업을 실행합니다.

이 작업은:

  • doc 디렉터리의 모든 파일을 확인합니다.

  • 메타데이터에서 group 값을 읽습니다. group의 값이 Rake 작업에 알려지지 않은 경우 해당 페이지는 Technical Writer에게 할당되지 않은 것으로 처리됩니다.

  • codeowners.rake 파일의 정보를 사용하여 CODEOWNERS 파일을 채웁니다.

CODEOWNERS 파일을 업데이트하려면:

  • 필요한 경우 영향을 받는 문서 페이지의 Stage 및 그룹 메타데이터를 업데이트합니다. 변경 사항이 많은 경우, 별도의 머지 리퀘스트에서 이 단계를 수행할 수 있습니다.

  • codeowners.rake 파일을 변경 사항으로 업데이트합니다.

  • gitlab 리포지터리 루트로 이동합니다.

  • 다음 명령어로 Rake 작업을 실행합니다: bundle exec rake tw:codeowners

  • CODEOWNERS 파일의 변경 사항을 검토합니다.

  • 모든 변경 사항을 추가하고 커밋한 후 브랜치를 origin으로 푸시합니다.

  • 머지 리퀘스트를 생성하고 Technical Writing 매니저에게 리뷰를 할당합니다.

codeowners.rake 파일을 업데이트할 때:

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

CodeOwnerRule.new('Group Name', '@writer1 @writer2'),

그룹 내 서로 다른 디렉터리의 문서에 다른 작성자를 할당하려면, path 매개변수를 사용하여 디렉터리를 지정합니다:

CodeOwnerRule.new('Group Name', ->(path) { path.start_with?('/doc/user') ? '@writer1' : '@writer2' }),

이 예시에서 writer1은 /doc/user에 있는 이 그룹과 관련된 파일의 코드 Owner입니다. 그 외 모든 파일에 대해서는 writer2가 코드 Owner로 지정됩니다. 예시는 MR 127903을 참조하세요.

할당된 작성자가 없는 그룹의 경우, 파일에 그룹 이름을 포함하고 해당 줄을 주석 처리합니다:

# CodeOwnerRule.new('Group Name', ''),