操作指南模板
创建操作指南的建议模板和指导
贡献新的操作指南
操作指南为读者提供逐步的实用指导,帮助他们实现以下目标:
- 启用某个功能
- 集成某项技术
- 在特定场景中使用 Dapr
操作指南相较于快速入门,是更高级别的自助文档。操作场景通常需要更长的时间,并且更容易应用于读者的个人项目或环境。
命名操作文档时,应在文件名中包含子目录名称。如果需要创建新的子目录,请确保其具有描述性,并包含相关组件或概念名称。例如,pubsub-namespaces。
注意
此模板仅为建议。可以根据文档的目的进行调整。了解更多关于贡献 Dapr 文档的信息,例如前置内容和短代码。
模板
---
type: #必填; docs
title: #必填; "如何:简洁明了的标题"
linkTitle: #必填; "如何:比常规标题更短,以便在目录中显示"
weight: #必填; 根据层级使用正确的权重
description: #必填; 对文章内容的期望进行一句话描述
---
<!--
在提交 PR 之前,请删除此模板中的所有注释。
-->
<!--
H1:Hugo 前置内容中的标题作为文章的 markdown H1。
-->
<!-- 引言段落
必填。简要介绍将涵盖的内容以及任何默认的 Dapr 特性。链接到适当的概念或概述文档以提供背景。 -->
<!--
如果可能,包含一个图表或图像。
-->
<!--
如果适用,请在短代码注释或警报中链接到相关的快速入门,文本如:
如果您还没有,请[尝试 <topic> 快速入门](link),以快速了解如何使用 <topic>。
-->
<!--
确保操作指南包含多个编程语言、操作系统或部署目标的示例(如果适用)。
-->
## <操作或任务>
<!--
与快速入门不同,不要使用“步骤 1”、“步骤 2”等。
-->
## <操作或任务>
<!--
每个 H2 步骤应以动词/动作词开头。
-->
<!--
尽可能包含代码片段。
-->
## 后续步骤
<!--
链接到相关页面和示例。例如,构建块概述、相关教程、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.