How-to guide template

Suggested template and guidance for creating a how-to guide

Contributing a new how-to guide

How-to guides provide step-by-step practical guidance to readers who wish to:

  • Enable a feature
  • Integrate a technology
  • Use Dapr in a specific scenario

How-to guides can be considered “next-level”, self-guided docs compared to quickstarts. How-to scenarios will take longer and can be more easily applied to the reader’s individual project or environment.

When naming your how-to document, include the sub-directory name in the file name. If you need to create a new sub-directory, make sure it’s descriptive and includes the relevant component or concept name. For example, pubsub-namespaces.

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; "How to: Brief, clear title"
  4. linkTitle: #Required; "How to: Shorter than regular title, to show in 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 how-to will cover and any default Dapr characteristics. Link off to the appropriate concept or overview docs to provide context. -->
  20. <!-- 
  21. Include a diagram or image, if possible. 
  22. -->
  24. <!--
  25. If applicable, link to the related quickstart in a shortcode note or alert with text like:
  27.  If you haven't already, [try out the <topic> quickstart](link) for a quick walk-through on how to use <topic>.
  29. -->
  31. <!-- 
  32. Make sure the how-to includes examples for multiple programming languages, OS, or deployment targets, if applicable. 
  33. -->
  35. ## <Action or task>
  37. <!-- 
  38. Unlike quickstarts, do not use "Step 1", "Step 2", etc.  
  39. -->
  41. ## <Action or task>
  43. <!-- 
  44. Each H2 step should start with a verb/action word.
  45. -->
  47. <!--
  48. Include code snippets where possible. 
  49. -->
  51. ## Next steps
  53. <!--
  54. Link to related pages and examples. For example, the building block overview, the related tutorial, API reference, etc.
  55. -->

Last modified October 11, 2024: Fixed typo (#4389) (fe17926)