快速入门指南模板
创建快速入门指南的建议模板和指导
贡献新的快速入门指南
Dapr 快速入门指南包含简明的说明,引导读者完成准备好的快速入门,这些内容保存在 dapr/quickstarts 仓库中。这些快速入门将整个功能或构建块打包在一起,使读者能够轻松体验其工作方式,而无需影响自己的项目。
快速入门说明应简洁、直接、清晰。快速入门指南的唯一目的是简单地指导读者完成准备好的快速入门。如果您想解释快速入门背后的概念,请引导读者阅读概念文章以获取更多背景信息。
注意
此模板仅作为建议。您可以根据文档的目的自由更改。了解有关贡献 Dapr 文档的更多信息,例如 front-matter 和 shortcodes。
模板
---
type: #必需;docs
title: #必需;"Quickstart: 简洁、清晰的标题"
linkTitle: #必需;这将显示在文档目录中
weight: #必需;根据层级使用正确的权重
description: #必需;一句话描述文章内容
---
<!--
在提交 PR 之前,请删除此模板中的所有注释。
-->
<!--
H1:Hugo front-matter 中的标题作为文章的 markdown H1。
-->
<!-- 介绍性段落
必需。简短的介绍,简要描述快速入门将涵盖的内容。链接到相应的概念或概述文档以提供背景信息。 -->
<!--
如果可能,请包含图表或图像。
-->
<!--
确保快速入门包含多种编程语言的示例。
-->
## 前置条件
<!--
通过列出读者可能需要的内容,确保读者为成功完成快速入门做好准备。
-->
## 步骤 1:设置环境
<!--
提供快速入门示例的链接,供读者克隆。
-->
## 步骤 2:<动作或任务>
<!--
每个 H2 步骤应以动词/动作词开头。
-->
<!--
尽可能包含代码片段。
-->
## 告诉我们您的想法!
我们正在不断努力改进我们的快速入门示例,并重视您的反馈。您觉得这个快速入门有帮助吗?您有改进建议吗?
加入我们的 [discord 频道](https://discord.gg/22ZtJrNe)参与讨论。
<!-- 由于 Dapr 是一个开放的贡献者社区,请确保提供 discord 讨论的链接以欢迎反馈。
-->
## 后续步骤
<!--
链接到相关页面和示例。例如,构建块概述、SDK 快速入门示例的 HTTP 版本等。
-->
<!--
使用按钮 shortcode 引导读者访问更深入的相关场景,例如 Dapr 教程。
-->