概念文章模板
创建概念文章的建议模板和指导
贡献新的概念或概述文章
概念(或概述)文章旨在回答以下问题:
- 为什么这个功能对你很重要?
- 它能帮助你解决哪些问题?
尽管组件、API 或 SDK 规范可以帮助读者理解如何使用这些功能,概念文章则提供了更深入的背景和上下文。请链接到规范文章,但尽量避免简单重复规范内容。
在为你的概念文章命名时,确保其名称、参数和术语与规范保持一致。如有必要,请同时更新两者。
注意
此模板仅为建议。可以根据文档的目的进行调整。了解更多关于为 Dapr 文档做贡献的信息,例如前置内容和短代码。
模板
---
type: #必填; docs
title: #必填; 简洁明了的标题
linkTitle: #必填; 简短标题
weight: #必填; 根据层级使用正确的权重
description: #必填; 对文章内容的简短描述
---
<!--
在打开 PR 之前,删除此模板中的所有注释。
-->
<!--
H1: Hugo 前置内容中的标题作为文章的 markdown H1。
-->
<!-- 简介段落
必填。简要介绍文章将涵盖的概念。链接到适当的参考、规范或操作指南以提供上下文。 -->
<!--
如果可能,包含图表或图片。
-->
## <章节 1 H2>
<!--
在此添加你的内容。
-->
## <章节 2 H2>
<!--
每个 H2 步骤应以名词/描述性词语开头。
-->
## <章节 3 H2>
<!--
在此添加你的内容。
-->
<!--
在适用的地方,包含图表或图片。
-->
## 体验 <概念>
<!--
如果适用,包含一个部分,链接到相关的快速开始、操作指南或教程。
-->
### 快速开始和教程
想要体验 Dapr <主题> API?通过以下快速开始和教程来了解 <主题> 的实际应用:
| 快速开始/教程 | 描述 |
| ------------------- | ----------- |
| [<主题> 快速开始](link) | 快速开始的描述。 |
| [<主题> 教程](link) | 教程的描述。 |
### 在你的应用中直接使用 <主题>
想跳过快速开始?没问题。你可以在你的应用中直接使用 <主题> 构建块。在[Dapr 安装完成](link)后,你可以开始使用 <主题> API,从[<主题> 操作指南](link)开始。
-->
## 下一步
<!--
链接到相关页面和示例。例如,相关的 API 规范,相关的构建块等。
-->
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.