Help us learn about your current experience with the documentation. Take the survey.

入门页面类型

入门页面介绍广泛功能领域的高级概念。 虽然特定功能可能在功能文档中定义, 但入门页面为一组概念提供介绍。 内容应帮助用户理解多个功能如何协同工作, 成为更大 GitLab 工作流程的一部分。

何时使用入门页面

目前,入门页面应仅在左侧导航的最高级别使用。 例如,您可能在管理您的组织扩展 GitLab下有一个入门页面。

入门页面与教程不同。入门页面专注于工作流程中的高级概念, 而教程帮助用户完成任务。 然而,入门页面应该指向教程,因为教程是用户入门的好方法。

格式

入门页面应采用以下格式:

title: 入门 abc
---

这些功能以这种方式协同工作。您可以使用它们实现这些目标。
包含一个将功能联系在一起的段落,而不描述每个单独功能的作用。

然后添加这句话和一张图表。关于图表文件的详细信息如下。

<abc> 的过程是更大工作流程的一部分:

![工作流程](img/workflow diagram.png)

## 步骤 1:执行此操作

每个步骤应按工作流程对功能进行分组。例如,步骤 1 可能是:

`## 步骤 1:确定您的发布节奏`

然后内容可以解释里程碑、迭代、标签等。
这些术语可能存在于文档的其他地方,但此页面上的描述
应该相对简洁。

最后,添加链接,格式如下:

更多信息,请参阅:

- [创建您的第一个 abc](link.md)。
- [了解更多关于 abc 的信息](link.md)。

## 步骤 2:下一个操作

不要在正文中添加链接。将链接保留在`更多信息`区域。

更多信息,请参阅:

- [创建您的第一个 abc](link.md)。
- [了解更多关于 abc 的信息](link.md)。

入门页面标题

标题使用 Get started with topic_name

左侧导航使用 Getting started

入门文件位置

所有入门文件都应放在 doc/user/get_started/ 文件夹中。 您不需要为每个文件创建子文件夹。

图表文件

图表文件位于此 Google Slides 文档

示例

有关入门页面类型的示例, 请参阅开始学习 Git