시작하기 페이지 유형
시작하기 페이지는 넓은 기능 영역에 대한 고수준 컨셉을 소개합니다. 특정 기능은 기능 문서에서 정의될 수 있지만, 시작하기 페이지는 일련의 컨셉에 대한 소개를 제공합니다. 콘텐츠는 사용자가 여러 기능이 GitLab 워크플로우의 일부로 어떻게 맞아 떨어지는지 이해하는 데 도움이 되어야 합니다.
시작하기 페이지를 사용해야 하는 경우
현재 시작하기 페이지는 왼쪽 탐색의 가장 높은 수준에서만 사용해야 합니다. 예를 들어, 조직 관리 또는 GitLab 확장 아래에 시작하기 페이지가 있을 수 있습니다.
시작하기 페이지는 튜토리얼과 다릅니다. 시작하기 페이지는 워크플로우의 고수준 컨셉에 중점을 두는 반면, 튜토리얼은 사용자가 작업을 수행하는 데 도움이 됩니다. 하지만 시작하기 페이지는 튜토리얼을 가리켜야 합니다. 왜냐하면 튜토리얼은 사용자가 처음 시작하는 데 좋은 방법이기 때문입니다.
형식
시작하기 페이지는 다음 형식을 따라야 합니다:
# topic_name으로 시작하기
이러한 기능은 이렇게 함께 작동합니다. 이러한 목표를 달성하는 데 사용할 수 있습니다.
각 개별 기능이 무엇을 하는지 설명하지 않고 기능을 묶는 단락을 포함하세요.
그런 다음 이 문장과 다이어그램을 추가하세요. 다이어그램 파일에 대한 세부 정보는 아래에 있습니다.
<abc>의 과정은 더 큰 워크플로우의 일부입니다:
## 단계 1: 이 작업 수행
각 단계는 워크플로우에 따라 기능을 그룹화해야 합니다. 예를 들어, 단계 1은 다음과 같을 수 있습니다:
`## 단계 1: 릴리스 주기 결정하기`
그런 다음 콘텐츠에서 마일스톤, 이터레이션, 레이블 등을 설명할 수 있습니다.
용어는 문서의 다른 곳에 있을 수 있지만, 이 페이지의 설명은 비교적 간단해야 합니다.
마지막으로 다음 형식으로 링크를 추가하세요:
더 많은 정보는 다음을 참조하세요:
- [첫 번째 abc 생성](link.md).
- [abc에 대해 자세히 알아보기](link.md).
## 단계 2: 다음 작업
본문 콘텐츠에는 링크를 걸지 마세요. 링크는 `더 많은 정보` 영역에 남겨두세요.
더 많은 정보는 다음을 참조하세요:
- [첫 번째 abc 생성](link.md).
- [abc에 대해 자세히 알아보기](link.md).
시작하기 페이지 제목
제목에는 topic_name으로 시작하기를 사용하세요.
왼쪽 탐색에는 시작하기를 사용하세요.
시작하기 파일 위치
모든 시작하기 파일은 doc/user/get_started/ 폴더에 있어야 합니다.
각 파일에 대해 서브폴더를 만들 필요는 없습니다.
다이어그램 파일
다이어그램 파일은 이 구글 슬라이드 문서에 있습니다.
예제
시작하기 페이지 유형의 예제는 Git 시작하기 학습하기를 참조하세요.
도움말