_tutorial-page-template.mdx 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. <!--
  2. title: Starts with an active verb, like "Create a widget" or "Delete a widget"
  3. description: Short summary (will be displayed in search engines)
  4. custom_edit_url: Edit URL of the source file
  5. author: "Your Name"
  6. author_title: "Your title at Netdata"
  7. author_img: "/img/authors/YourFace.jpg"
  8. keywords: [keywords, describing, the main topics]
  9. -->
  10. A paragraph that explains what the tutorial does, why it matters, and the expected outcome.
  11. To achieve goal:
  12. 1. [Do the first task](#first-task)
  13. 2. [Do the second task](#second-task)
  14. ## Prerequisites
  15. <!-- If there is only one requirement, use a paragraph instead of a single bullet item. Bullets are social animals and only appear in groups of 2 or more :) -->
  16. Optional. List all needed prerequisites:
  17. - Prerequisite 1
  18. - Prerequisite 2
  19. - Prerequisite 3
  20. ## First task
  21. To do x:
  22. 1. Step 1 written in active voice
  23. ```bash
  24. Code sample for step
  25. ```
  26. 2. Step 2
  27. Result of step 2, for example a system reaction; written in passive voice
  28. 3. Step 3
  29. ## Second task
  30. To do x:
  31. 1. Step 1 written in active voice
  32. ```bash
  33. Code sample for step
  34. ```
  35. 2. Step 2
  36. Result of step 2, for example a system reaction; written in passive voice
  37. 3. Step 3
  38. ## What's next?
  39. Optional section that explains the next logical steps.