Quickstart guide template

Suggested template and guidance for creating a quickstart guide

Contributing a new quickstart guide

Dapr quickstart guides consist of quick instructions that walk readers through a prepared quickstart, saved to the dapr/quickstarts repo. These quickstarts package an entire feature or building block in one place, making it easy for the reader to experience how it works without compromising their own project.

The quickstart instructions should be succinct, direct, and clear. The sole purpose of a quickstart guide is to simply instruct a reader through the prepared quickstart. If you’d like to explain the concepts behind the quickstart, direct the reader to a concept article for more context.

Note

This template is only a suggestion. Feel free to change based on your document’s purpose.

Learn more about contributing to the Dapr docs, like front-matter and shortcodes.

Template

  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. -->

Last modified September 27, 2022: Docs contributing guide updates (#2768) (73861088)