InfoGrab DocsInfoGrab Docs

튜토리얼 페이지 유형

요약

튜토리얼은 복잡한 워크플로 또는 시나리오를 처음부터 끝까지 단계별로 안내하는 페이지입니다. 워크플로가 각각 하위 단계로 구성된 순차적 단계를 필요로 하는 경우. 단계들이 다양한 GitLab 기능 또는 서드파티 도구를 포함하는 경우.

튜토리얼은 복잡한 워크플로 또는 시나리오를 처음부터 끝까지 단계별로 안내하는 페이지입니다. 일반적으로 다음과 같은 경우에 튜토리얼 사용을 고려할 수 있습니다:

  • 워크플로가 각각 하위 단계로 구성된 순차적 단계를 필요로 하는 경우.

  • 단계들이 다양한 GitLab 기능 또는 서드파티 도구를 포함하는 경우.

튜토리얼 가이드#

  • 튜토리얼은 태스크가 아닙니다. 태스크는 하나의 절차에 대한 지침을 제공합니다. 튜토리얼은 여러 태스크를 결합하여 특정 목표를 달성합니다.

  • 튜토리얼은 실제 동작하는 예시를 제공합니다. 이상적으로는 독자가 튜토리얼에서 설명하는 예시를 직접 만들 수 있어야 합니다. 정확히 재현할 수 없더라도 유사한 것을 재현할 수 있어야 합니다.

  • 튜토리얼은 새로운 기능을 소개하지 않습니다.

  • 튜토리얼은 문서 사이트의 다른 곳에서도 확인할 수 있는 정보를 포함할 수 있습니다.

튜토리얼 파일명 및 위치#

튜토리얼 Markdown 파일은 다음 중 하나를 선택할 수 있습니다:

  • 제품 문서가 있는 디렉터리에 파일을 저장합니다.

  • doc/tutorials 하위에 하위 폴더를 만들고 파일 이름을 _index.md로 지정합니다.

왼쪽 내비게이션에서는 관련 기능 문서 근처에 튜토리얼을 추가하거나, 관련 튜토리얼 랜딩 페이지 하위에 중첩하여 추가합니다.

랜딩 페이지 중 하나에 튜토리얼 링크를 추가합니다.

튜토리얼 형식#

튜토리얼은 다음 형식을 따라야 합니다:

title: Title (starts with "Tutorial:" followed by an active verb, like "Tutorial: Create a website")
---

<!-- vale gitlab_base.FutureTense = NO -->

A paragraph that explains what the tutorial does, and the expected outcome.

Optionally, list the steps in the tutorial. Omit this for short tutorials. Do not link to the steps.

To create a website:

1. Do the first task
1. Do the second task

## Before you begin

This section is optional.

- Thing 1
- Thing 2
- Thing 3

## Do the first task

To do step 1:

1. First step.
1. Another step.
1. Another step.

## Do the second task

Before you begin, make sure you have [done the first task](#do-the-first-task).

To do step 2:

1. First step.
1. Another step.
1. Another step.

이 형식을 따르는 튜토리얼 예시는 Tutorial: Make your first Git commit입니다.

가이드가 포함된 튜토리얼 형식#

복잡한 단계가 있는 튜토리얼의 경우 guide 단축코드를 사용하여 각 섹션의 단계를 스타일화된 순서 목록으로 만들 수 있습니다. 예를 들면:

## Do the first task

Briefly explain what we're going to do in this task.



1. Do the first thing. Keep this sentence short and always use a period.

   This is how you do the first thing. Provide navigation steps,
   additional details, example code, and screenshots here.

1. Do the second thing.

   This is how you do the second thing.

1. Do the third thing.

   This is how you do the third thing.

이 형식을 따르는 튜토리얼 예시는 Tutorial: Update Git commit messages입니다.

튜토리얼 페이지 제목#

페이지 제목은 Tutorial:로 시작하고 그 뒤에 능동 동사를 붙입니다. 예를 들어 Tutorial: Create a website와 같이 작성합니다.

왼쪽 내비게이션에서는 전체 페이지 제목을 사용합니다. 줄여 쓰지 않습니다. 파이프라인이 성공적으로 실행되도록 텍스트를 따옴표로 묶습니다. 예를 들어 "Tutorial: Make your first Git commit"와 같이 작성합니다.

GitLab 튜토리얼로 배우기 페이지에서는 제목에 Tutorial을 사용하지 않습니다.

스크린샷#

튜토리얼에서는 프로세스의 중요한 단계를 설명하기 위해 스크린샷을 포함할 수 있습니다. 핵심 제품 문서에서는 일러스트레이션을 적게 사용해야 합니다. 그러나 튜토리얼에서는 스크린샷이 복잡한 프로세스의 어느 단계에 있는지 사용자가 이해하는 데 도움이 될 수 있습니다.

스크린샷 수를 적절히 조절하여 서술 흐름을 방해하지 않도록 합니다. 예를 들어 튜토리얼 중간에 큰 스크린샷 하나를 넣지 않습니다. 대신, 여러 개의 작은 스크린샷을 전체에 걸쳐 배치합니다.

튜토리얼 어조#

다른 주제 유형보다 더 친근한 어조를 사용합니다. 예를 들어 다음과 같이 할 수 있습니다:

  • 태스크 완료 후 격려하거나 축하하는 표현을 추가합니다.

  • 특히 단계를 소개할 때 미래 시제를 가끔 사용합니다. 예를 들어 Next, you will associate your issues with your epics와 같이 작성합니다. 거짓 양성을 방지하려면 Vale 규칙 gitlab_base.FutureTense를 비활성화합니다.

  • 더 대화체로 작성합니다. 예를 들어 This task might take a while to complete와 같이 작성합니다.

메타데이터#

튜토리얼인 페이지에는 파일 상단에 가장 적합한 stage:와 group: 메타데이터를 추가합니다. 콘텐츠의 대부분이 하나의 그룹에 해당하지 않는 경우 stage에는 Tutorials를, group에는 Tutorials를 지정합니다:

stage: Tutorials
group: Tutorials

튜토리얼 페이지 유형

GitLab v19.1
원문 보기
요약

튜토리얼은 복잡한 워크플로 또는 시나리오를 처음부터 끝까지 단계별로 안내하는 페이지입니다. 워크플로가 각각 하위 단계로 구성된 순차적 단계를 필요로 하는 경우. 단계들이 다양한 GitLab 기능 또는 서드파티 도구를 포함하는 경우.

튜토리얼은 복잡한 워크플로 또는 시나리오를 처음부터 끝까지 단계별로 안내하는 페이지입니다. 일반적으로 다음과 같은 경우에 튜토리얼 사용을 고려할 수 있습니다:

  • 워크플로가 각각 하위 단계로 구성된 순차적 단계를 필요로 하는 경우.

  • 단계들이 다양한 GitLab 기능 또는 서드파티 도구를 포함하는 경우.

튜토리얼 가이드#

  • 튜토리얼은 태스크가 아닙니다. 태스크는 하나의 절차에 대한 지침을 제공합니다. 튜토리얼은 여러 태스크를 결합하여 특정 목표를 달성합니다.

  • 튜토리얼은 실제 동작하는 예시를 제공합니다. 이상적으로는 독자가 튜토리얼에서 설명하는 예시를 직접 만들 수 있어야 합니다. 정확히 재현할 수 없더라도 유사한 것을 재현할 수 있어야 합니다.

  • 튜토리얼은 새로운 기능을 소개하지 않습니다.

  • 튜토리얼은 문서 사이트의 다른 곳에서도 확인할 수 있는 정보를 포함할 수 있습니다.

튜토리얼 파일명 및 위치#

튜토리얼 Markdown 파일은 다음 중 하나를 선택할 수 있습니다:

  • 제품 문서가 있는 디렉터리에 파일을 저장합니다.

  • doc/tutorials 하위에 하위 폴더를 만들고 파일 이름을 _index.md로 지정합니다.

왼쪽 내비게이션에서는 관련 기능 문서 근처에 튜토리얼을 추가하거나, 관련 튜토리얼 랜딩 페이지 하위에 중첩하여 추가합니다.

랜딩 페이지 중 하나에 튜토리얼 링크를 추가합니다.

튜토리얼 형식#

튜토리얼은 다음 형식을 따라야 합니다:

title: Title (starts with "Tutorial:" followed by an active verb, like "Tutorial: Create a website")
---

<!-- vale gitlab_base.FutureTense = NO -->

A paragraph that explains what the tutorial does, and the expected outcome.

Optionally, list the steps in the tutorial. Omit this for short tutorials. Do not link to the steps.

To create a website:

1. Do the first task
1. Do the second task

## Before you begin

This section is optional.

- Thing 1
- Thing 2
- Thing 3

## Do the first task

To do step 1:

1. First step.
1. Another step.
1. Another step.

## Do the second task

Before you begin, make sure you have [done the first task](#do-the-first-task).

To do step 2:

1. First step.
1. Another step.
1. Another step.

이 형식을 따르는 튜토리얼 예시는 Tutorial: Make your first Git commit입니다.

가이드가 포함된 튜토리얼 형식#

복잡한 단계가 있는 튜토리얼의 경우 guide 단축코드를 사용하여 각 섹션의 단계를 스타일화된 순서 목록으로 만들 수 있습니다. 예를 들면:

## Do the first task

Briefly explain what we're going to do in this task.



1. Do the first thing. Keep this sentence short and always use a period.

   This is how you do the first thing. Provide navigation steps,
   additional details, example code, and screenshots here.

1. Do the second thing.

   This is how you do the second thing.

1. Do the third thing.

   This is how you do the third thing.

이 형식을 따르는 튜토리얼 예시는 Tutorial: Update Git commit messages입니다.

튜토리얼 페이지 제목#

페이지 제목은 Tutorial:로 시작하고 그 뒤에 능동 동사를 붙입니다. 예를 들어 Tutorial: Create a website와 같이 작성합니다.

왼쪽 내비게이션에서는 전체 페이지 제목을 사용합니다. 줄여 쓰지 않습니다. 파이프라인이 성공적으로 실행되도록 텍스트를 따옴표로 묶습니다. 예를 들어 "Tutorial: Make your first Git commit"와 같이 작성합니다.

GitLab 튜토리얼로 배우기 페이지에서는 제목에 Tutorial을 사용하지 않습니다.

스크린샷#

튜토리얼에서는 프로세스의 중요한 단계를 설명하기 위해 스크린샷을 포함할 수 있습니다. 핵심 제품 문서에서는 일러스트레이션을 적게 사용해야 합니다. 그러나 튜토리얼에서는 스크린샷이 복잡한 프로세스의 어느 단계에 있는지 사용자가 이해하는 데 도움이 될 수 있습니다.

스크린샷 수를 적절히 조절하여 서술 흐름을 방해하지 않도록 합니다. 예를 들어 튜토리얼 중간에 큰 스크린샷 하나를 넣지 않습니다. 대신, 여러 개의 작은 스크린샷을 전체에 걸쳐 배치합니다.

튜토리얼 어조#

다른 주제 유형보다 더 친근한 어조를 사용합니다. 예를 들어 다음과 같이 할 수 있습니다:

  • 태스크 완료 후 격려하거나 축하하는 표현을 추가합니다.

  • 특히 단계를 소개할 때 미래 시제를 가끔 사용합니다. 예를 들어 Next, you will associate your issues with your epics와 같이 작성합니다. 거짓 양성을 방지하려면 Vale 규칙 gitlab_base.FutureTense를 비활성화합니다.

  • 더 대화체로 작성합니다. 예를 들어 This task might take a while to complete와 같이 작성합니다.

메타데이터#

튜토리얼인 페이지에는 파일 상단에 가장 적합한 stage:와 group: 메타데이터를 추가합니다. 콘텐츠의 대부분이 하나의 그룹에 해당하지 않는 경우 stage에는 Tutorials를, group에는 Tutorials를 지정합니다:

stage: Tutorials
group: Tutorials