快速入门指南文章模板

创建快速入门指南的建议模板和指南

贡献新的 quickstart 指南

Dapr快速入门指南由快速指令组成，引导读者完成准备好的快速入门，保存在dapr/quickstarts存储库。 这些快速入门将整个功能或构建块打包在一个地方，使读者能够体验其工作方式，而不会影响他们自己的项目。

快速入门说明应该简洁、直接和清晰。 快速入门指南的唯一目的就是简单地指导读者完成准备好的快速入门。 如果您想解释快速入门背后的概念，请将读者引导至一个概念文章以获取更多上下文。

注意

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

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

模板

  1. ---
  2. type: #Required; docs
  3. title: #Required; "Quickstart: Brief, clear title"
  4. linkTitle: #Required; This will display in the docs table of contents
  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. Light intro that briefly describes what the quickstart will cover. Link off to the appropriate concept or overview docs to provide context. -->
  20. <!-- 
  21. Include a diagram or image, if possible. 
  22. -->
  24. <!-- 
  25. Make sure the quickstart includes examples for multiple programming languages. 
  26. -->
  28. ## Pre-requisites
  30. <!--
  31. Make sure the reader is prepared for a successful quickstart walk through by listing what they may need.
  32. -->
  34. ## Step 1: Set up the environment
  36. <!-- 
  37. Link to the quickstart sample for the reader to clone. 
  38. -->
  40. ## Step 2: <action or task>
  42. <!-- 
  43. Each H2 step should start with a verb/action word.
  44. -->
  46. <!--
  47. Include code snippets where possible. 
  48. -->
  50. ## Tell us what you think!
  52. We're continuously working to improve our Quickstart examples and value your feedback. Did you find this quickstart helpful? Do you have suggestions for improvement?
  54. Join the discussion in our [discord channel](https://discord.gg/22ZtJrNe).
  56. <!-- Since Dapr is an open community of contributors, make sure to provide a link to the discord discussion to welcome feedback.
  57. -->
  59. ## Next steps
  61. <!--
  62. Link to related pages and examples. For example, the building block overview, the HTTP version of an SDK quickstart sample, etc.
  63. -->
  65. <!--
  66. Use the button shortcode to direct readers to more in-depth, related scenarios, like the Dapr tutorials.
  67. -->