Dapr 文档模板建议 on Dapr 文档库

概念文章模板

Mon, 01 Jan 0001 00:00:00 +0000

贡献新的概念或概述文章

概念（或概述）文章旨在回答以下问题：

为什么这个功能对你很重要？
它能帮助你解决哪些问题？

尽管组件、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 规范，相关的构建块等。
-->

快速入门指南模板

Mon, 01 Jan 0001 00:00:00 +0000

贡献新的快速入门指南

Dapr 快速入门指南包含一些简明的指令，帮助读者完成一个预先准备好的快速入门项目，这些项目保存在 dapr/quickstarts 仓库中。这些快速入门将整个功能或构建块集中在一起，使读者能够轻松体验其工作原理，而不影响他们自己的项目。

快速入门指令应当简洁明了。快速入门指南的唯一目的是简单地指导读者完成准备好的快速入门。如果您想解释快速入门背后的概念，请将读者引导到相关的概念文章以获取更多背景信息。

注意

此模板仅为建议。可以根据文档的具体需求进行调整。

了解更多关于如何贡献 Dapr 文档的信息，例如前置内容和短代码。

模板

---
type: #必填; docs
title: #必填; "快速入门：简洁明了的标题"
linkTitle: #必填; 这将在文档目录中显示
weight: #必填; 根据层级使用正确的权重
description: #必填; 一句话描述文章的预期内容
---

<!--
在提交 PR 之前，删除此模板中的所有注释。
-->

<!-- 
H1：Hugo 前置内容中的标题作为文章的 markdown H1。
-->

<!-- 引言段落 
必填。简要介绍快速入门将涵盖的内容。链接到适当的概念或概述文档以提供背景。 -->

<!-- 
如果可能，包含一个图表或图像。
-->

<!-- 
确保快速入门包含多个编程语言的示例。
-->

## 前置条件

<!--
列出读者在开始快速入门之前可能需要准备的内容，以确保顺利完成。
-->

## 步骤 1：设置环境

<!-- 
提供快速入门示例的链接，供读者克隆。
-->

## 步骤 2：<操作或任务>

<!-- 
每个 H2 步骤应以动词/动作词开头。
-->

<!--
尽可能包含代码片段。
-->

## 告诉我们您的想法！

我们正在不断努力改进我们的快速入门示例，并重视您的反馈。您觉得这个快速入门有帮助吗？您有改进建议吗？

欢迎加入我们的 [discord 频道](https://discord.gg/22ZtJrNe)进行讨论。

<!-- 由于 Dapr 是一个开放的贡献者社区，请确保提供 discord 讨论的链接以欢迎反馈。
-->

## 下一步

<!--
链接到相关页面和示例。例如，构建块概述，SDK 快速入门示例的 HTTP 版本等。
-->

<!--
使用按钮短代码将读者引导到更深入的相关场景，例如 Dapr 教程。
-->

操作指南模板

Mon, 01 Jan 0001 00:00:00 +0000

贡献新的操作指南

操作指南为读者提供逐步的实用指导，帮助他们实现以下目标：

启用某个功能
集成某项技术
在特定场景中使用 Dapr

操作指南相较于快速入门，是更高级别的自助文档。操作场景通常需要更长的时间，并且更容易应用于读者的个人项目或环境。

命名操作文档时，应在文件名中包含子目录名称。如果需要创建新的子目录，请确保其具有描述性，并包含相关组件或概念名称。例如，pubsub-namespaces。

注意

此模板仅为建议。可以根据文档的目的进行调整。

了解更多关于贡献 Dapr 文档的信息，例如前置内容和短代码。

模板

---
type: #必填; docs
title: #必填; "如何：简洁明了的标题"
linkTitle: #必填; "如何：比常规标题更短，以便在目录中显示"
weight: #必填; 根据层级使用正确的权重
description: #必填; 对文章内容的期望进行一句话描述
---

<!--
在提交 PR 之前，请删除此模板中的所有注释。
-->

<!-- 
H1：Hugo 前置内容中的标题作为文章的 markdown H1。
-->

<!-- 引言段落 
必填。简要介绍将涵盖的内容以及任何默认的 Dapr 特性。链接到适当的概念或概述文档以提供背景。 -->

<!-- 
如果可能，包含一个图表或图像。
-->

<!--
如果适用，请在短代码注释或警报中链接到相关的快速入门，文本如：

 如果您还没有，请[尝试 <topic> 快速入门](link)，以快速了解如何使用 <topic>。

-->

<!-- 
确保操作指南包含多个编程语言、操作系统或部署目标的示例（如果适用）。
-->

## <操作或任务>

<!-- 
与快速入门不同，不要使用“步骤 1”、“步骤 2”等。
-->

## <操作或任务>

<!-- 
每个 H2 步骤应以动词/动作词开头。
-->

<!--
尽可能包含代码片段。
-->

## 后续步骤

<!--
链接到相关页面和示例。例如，构建块概述、相关教程、API 参考等。
-->