教程页面类型

教程是一个包含复杂工作流或场景端到端演练的页面。 通常，在以下情况你可能考虑使用教程：

• 工作流需要顺序步骤，每个步骤包含子步骤。
• 步骤涵盖多种 GitLab 功能或第三方工具。

教程指南

• 教程不是任务。任务是一个过程的说明。 教程结合多个任务来实现特定目标。
• 教程提供一个可运行的示例。理想情况下，读者可以创建教程描述的示例。 如果他们无法完全复制，也应该能够复制类似的内容。
• 教程不介绍新功能。
• 教程可以包含文档站点其他地方也可用的信息。

教程文件名和位置

对于教程 Markdown 文件，你可以：

• 将文件保存在产品文档目录中。
• 在 doc/tutorials 下创建子文件夹，并将文件命名为 _index.md。

在左侧导航中，将教程添加到相关功能文档附近。

在其中一个教程页面上添加教程链接。

教程格式

教程应采用以下格式：

title: 标题（以"Tutorial:"开头，后跟主动词，如"教程：创建网站"）
---

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

一段解释教程内容和预期结果的文字。

要创建网站：

1. [执行第一个任务](#do-the-first-task)
1. [执行第二个任务](#do-the-second-task)

## 开始之前

此部分为可选。

- 事项 1
- 事项 2
- 事项 3

## 执行第一个任务

要执行步骤 1：

1. 第一步。
1. 另一步。
1. 再一步。

## 执行第二个任务

开始之前，请确保你已经[完成了第一个任务](#do-the-first-task)。

要执行步骤 2：

1. 第一步。
1. 另一步。
1. 再一步。

遵循此格式的教程示例是 教程：进行你的第一次 Git 提交。

教程页面标题

以 Tutorial: 开头页面标题，后跟主动词，如 教程：创建网站。

在左侧导航中，使用完整的页面标题。不要缩写。 将文本放在引号中，以便流水线成功。例如， "教程：进行你的第一次 Git 提交"。

在通过教程学习 GitLab页面上， 标题中不要使用 Tutorial。

截图

你可以在教程中包含截图来说明过程中的重要步骤。 在核心产品文档中，你应该谨慎使用插图。 然而，在教程中，截图可以帮助用户了解他们在复杂进程中的位置。

尝试平衡教程中的截图数量，以免破坏叙述流程。例如， 不要在教程中间放置一张大截图。相反，在整个教程中放置多个小截图。

教程语气

使用比其他主题类型更友好的语气。例如，你可以：

• 在任务后添加鼓励或祝贺的短语。
• 偶尔使用将来时态，特别是在介绍步骤时。例如， 接下来，你将把你的问题与你的史诗关联起来。 禁用 Vale 规则 gitlab_base.FutureTense 以避免误报。
• 更加口语化。例如，这个任务可能需要一些时间才能完成。

元数据

在教程页面上，在文件顶部添加最合适的 stage: 和 group: 元数据。 如果大部分内容不与单个组对齐，请为阶段指定 none，为组指定 Tutorials：

stage: none
group: Tutorials