概念文章模板

创建概念文章的建议模板和指南

贡献新的概念或概述文章

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

  • 你为什么要关心这个功能？
  • 它能帮他们解决什么问题?

虽然组件、API或SDK规范可以帮助读者了解如何使用或处理这些功能，但概念文章提供了更深入的内容和背景。 链接到规范文章，但尽量不要简单重复规范。

在命名概念文章时，请确保其在名称、参数和术语方面与规范一致。 确保根据需要更新两者。

注意

这个模板只是一个建议。 根据您的文档目的随意更改。

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

模板

  1. ---
  2. type: #Required; docs
  3. title: #Required; Brief, clear title
  4. linkTitle: #Required; Brief title
  5. weight: #Required; Use the correct weight based on hierarchy
  6. description: #Required; One-sentence description of what to expect in the article
  7. ---
  9. <!--
  10. Remove all the comments in this template before opening a PR.
  11. -->
  13. <!-- 
  14. H1: The title in the Hugo front-matter serves as the article's markdown H1. 
  15. -->
  17. <!-- Introductory paragraph  
  18. Required. Brief intro that describes the concepts that the article will cover. Link off to the appropriate reference, specs, or how-to guides to provide context. -->
  20. <!-- 
  21. Include a diagram or image, if possible. 
  22. -->
  24. ## <Section 1 H2>
  26. <!-- 
  27. Add your content here.  
  28. -->
  30. ## <Section 2 H2>
  32. <!-- 
  33. Each H2 step should start with a noun/descriptive word.
  34. -->
  36. ## <Section 3 H2>
  38. <!--
  39. Add your content here.
  40. -->
  42. <!--
  43. Include diagrams or images throughout, where applicable.
  44. -->
  46. ## Try out <concept>
  48. <!-- 
  49. If applicable, include a section with links to the related quickstart, how-to guides, or tutorials. --> 
  51. ### Quickstarts and tutorials
  53. Want to put the Dapr <topic> API to the test? Walk through the following quickstart and tutorials to see <topic> in action:
  55. | Quickstart/tutorial | Description |
  56. | ------------------- | ----------- |
  57. | [<topic> quickstart](link) | Description of the quickstart. |
  58. | [<topic> tutorial](link) | Description of the tutorial. |
  60. ### Start using <topic> directly in your app
  62. Want to skip the quickstarts? Not a problem. You can try out the <topic> building block directly in your application. After [Dapr is installed](link), you can begin using the <topic> API, starting with [the <topic> how-to guide](link).
  65. -->
  67. ## Next steps
  69. <!--
  70. Link to related pages and examples. For example, the related API spec, related building blocks, etc.
  71. -->