InfoGrab DocsInfoGrab Docs

시작하기 페이지 유형

요약

시작하기 페이지는 광범위한 기능 영역에 대한 고수준 개념을 소개합니다. 현재 시작하기 페이지는 왼쪽 내비게이션의 최상위 레벨에서만 사용해야 합니다. 시작하기 페이지는 튜토리얼과 다릅니다. 시작하기 페이지는 다음 형식을 따라야 합니다:

시작하기 페이지는 광범위한 기능 영역에 대한 고수준 개념을 소개합니다. 특정 기능이 해당 기능 문서에서 정의될 수 있지만, 시작하기 페이지는 일련의 개념에 대한 입문을 제공합니다. 콘텐츠는 사용자가 더 큰 GitLab 워크플로의 일부로서 여러 기능이 어떻게 맞물리는지 이해하는 데 도움을 주어야 합니다.

시작하기 페이지를 사용하는 시점#

현재 시작하기 페이지는 왼쪽 내비게이션의 최상위 레벨에서만 사용해야 합니다. 예를 들어, 조직 관리 또는 GitLab 확장 아래에 시작하기 페이지를 둘 수 있습니다.

시작하기 페이지는 튜토리얼과 다릅니다. 시작하기 페이지는 워크플로의 일부인 고수준 개념에 초점을 맞추는 반면, 튜토리얼은 사용자가 특정 작업을 수행할 수 있도록 돕습니다. 그러나 튜토리얼은 사용자가 시작하기에 좋은 방법이므로, 시작하기 페이지는 튜토리얼을 링크해야 합니다.

형식#

시작하기 페이지는 다음 형식을 따라야 합니다:

title: Get started with abc
---

These features work together in this way. You can use them to achieve these goals.
Include a paragraph that ties together the features without describing what
each individual feature does.

Then add this sentence and a diagram. Details about the diagram
file are below.

The process of <abc> is part of a larger workflow:

![Workflow](img/workflow diagram.png)

## Step 1: Do this thing

Each step should group features by workflow. For example, step 1 might be:

`## Step 1: Determine your release cadence`

Then the content can explain milestones, iterations, labels, etc.
The terms can exist elsewhere in the docs, but the descriptions
on this page should be relatively brief.

Finally, add links, in this format:

For more information, see:

- [Create your first abc](link.md).
- [Learn more about abc](link.md).

## Step 2: The next thing

Don't link in the body content. Save links for the `for more information` area.

For more information, see:

- [Create your first abc](link.md).
- [Learn more about abc](link.md).

시작하기 페이지 제목#

제목에는 Get started with topic_name을 사용합니다.

왼쪽 내비게이션에는 Getting started를 사용합니다.

시작하기 파일 위치#

모든 Getting started 파일은 doc/user/get_started/ 폴더에 있어야 합니다. 각 파일마다 하위 폴더를 만들 필요는 없습니다.

다이어그램 파일#

다이어그램 파일은 이 Google Slides 문서에 있습니다.

예시#

시작하기 페이지 유형의 예시는 Git 학습 시작하기를 참조하세요.

시작하기 페이지 유형

GitLab v19.1
원문 보기
요약

시작하기 페이지는 광범위한 기능 영역에 대한 고수준 개념을 소개합니다. 현재 시작하기 페이지는 왼쪽 내비게이션의 최상위 레벨에서만 사용해야 합니다. 시작하기 페이지는 튜토리얼과 다릅니다. 시작하기 페이지는 다음 형식을 따라야 합니다:

시작하기 페이지는 광범위한 기능 영역에 대한 고수준 개념을 소개합니다. 특정 기능이 해당 기능 문서에서 정의될 수 있지만, 시작하기 페이지는 일련의 개념에 대한 입문을 제공합니다. 콘텐츠는 사용자가 더 큰 GitLab 워크플로의 일부로서 여러 기능이 어떻게 맞물리는지 이해하는 데 도움을 주어야 합니다.

시작하기 페이지를 사용하는 시점#

현재 시작하기 페이지는 왼쪽 내비게이션의 최상위 레벨에서만 사용해야 합니다. 예를 들어, 조직 관리 또는 GitLab 확장 아래에 시작하기 페이지를 둘 수 있습니다.

시작하기 페이지는 튜토리얼과 다릅니다. 시작하기 페이지는 워크플로의 일부인 고수준 개념에 초점을 맞추는 반면, 튜토리얼은 사용자가 특정 작업을 수행할 수 있도록 돕습니다. 그러나 튜토리얼은 사용자가 시작하기에 좋은 방법이므로, 시작하기 페이지는 튜토리얼을 링크해야 합니다.

형식#

시작하기 페이지는 다음 형식을 따라야 합니다:

title: Get started with abc
---

These features work together in this way. You can use them to achieve these goals.
Include a paragraph that ties together the features without describing what
each individual feature does.

Then add this sentence and a diagram. Details about the diagram
file are below.

The process of <abc> is part of a larger workflow:

![Workflow](img/workflow diagram.png)

## Step 1: Do this thing

Each step should group features by workflow. For example, step 1 might be:

`## Step 1: Determine your release cadence`

Then the content can explain milestones, iterations, labels, etc.
The terms can exist elsewhere in the docs, but the descriptions
on this page should be relatively brief.

Finally, add links, in this format:

For more information, see:

- [Create your first abc](link.md).
- [Learn more about abc](link.md).

## Step 2: The next thing

Don't link in the body content. Save links for the `for more information` area.

For more information, see:

- [Create your first abc](link.md).
- [Learn more about abc](link.md).

시작하기 페이지 제목#

제목에는 Get started with topic_name을 사용합니다.

왼쪽 내비게이션에는 Getting started를 사용합니다.

시작하기 파일 위치#

모든 Getting started 파일은 doc/user/get_started/ 폴더에 있어야 합니다. 각 파일마다 하위 폴더를 만들 필요는 없습니다.

다이어그램 파일#

다이어그램 파일은 이 Google Slides 문서에 있습니다.

예시#

시작하기 페이지 유형의 예시는 Git 학습 시작하기를 참조하세요.