概念文章模板
创建概念文章的建议模板和指导
贡献新的概念或概述文章
概念(或概述)文章回答以下问题:
- 为什么要关注此功能?
- 它能帮助你解决哪些问题?
虽然组件、API 或 SDK 规范可能帮助读者了解如何使用或使用这些功能,但概念文章提供了更深层次和上下文。可以链接到规范文章,但尽量不要简单重复规范内容。
在命名概念文章时,确保名称、参数和术语与规范保持一致。必要时确保两者都得到更新。
Note
此模板仅是建议。可根据文档目的自由更改。了解更多关于贡献 Dapr 文档的信息,例如 front-matter 和 shortcodes。
模板
---
type: #Required; docs
title: #Required; 简短、清晰的标题
linkTitle: #Required; 简短标题
weight: #Required; 根据层级使用正确的权重
description: #Required; 一句话描述文章内容
---
<!--
在打开 PR 之前,请删除此模板中的所有注释。
-->
<!--
H1:Hugo front-matter 中的标题作为文章的 markdown H1。
-->
<!-- 简介
必需。简要介绍文章将涵盖的概念。链接到相应的参考、规范或操作指南以提供上下文。 -->
<!--
如果可能,包含图表或图像。
-->
## <第 1 节 H2>
<!--
在此添加你的内容。
-->
## <第 2 节 H2>
<!--
每个 H2 步骤应以名词/描述性词开头。
-->
## <第 3 节 H2>
<!--
在此添加你的内容。
-->
<!--
在适用的地方,通篇包含图表或图像。
-->
## 尝试 <概念>
<!--
如果适用,包含一个部分,链接到相关的快速入门、操作指南或教程。 -->
### 快速入门和教程
想要测试 Dapr <主题> API?完成以下快速入门和教程,查看 <主题> 的实际应用:
| 快速入门/教程 | 描述 |
| ------------------- | ----------- |
| [<主题> 快速入门](link) | 快速入门的描述。 |
| [<主题> 教程](link) | 教程的描述。 |
### 直接在应用中使用 <主题>
想要跳过快速入门?没问题。你可以直接在应用中尝试 <主题> 构建块。[安装 Dapr](link) 后,即可开始使用 <主题> API,从 [<主题> 操作指南](link) 开始。
-->
## 后续步骤
<!--
链接到相关页面和示例。例如,相关 API 规范、相关构建块等。
-->