User Doc How-to Template

User doc teams to follow this template to write a procedural topic.

Markdown template

Copy the contents to an empty markdown file and start editing. Remove the help text in block quotes and any unused sections.

Note: The frontmatter yaml provider in this template follows Docusaurus requirements but can be skipped or replaced with the format used by your preferred tool.

---
tags: ["Product","Component","Task"] 
title: "Add Topic title"
sidebar_label: "Title used for the sidebar"
slug: topic-slug
sidebar_position: number that dictates the placement of topic in the sidebar
description: Short description abou the topic
last_update:
  date: DD/MM/YYYY
  author: Author Name
---

## Overview

Summarize what this how-to article is about in a sentence or two. How-to articles primarily include tasks and answer the question "How do I do it?".

## Prerequisites
<!-- Delete this section if your readers can go to the steps without requiring any prerequisite knowledge. -->
Before you begin, make sure that:

* Prerequisite one.
* Prerequisite two.

Include other important information here, such as known issues or bugs.

## Step-by-step guide

1. Optional title for step: Image or screenshot.

<!-- When an image, such as a screenshot, is quicker to interpret than descriptive text, put the screenshot first. Otherwise, lead with the text. -->

![alt text](https://upload.wikimedia.org/wikipedia/commons/3/35/Tux.svg "Image title that describes image.")

Brief instructions explaining how to interpret the image.

2. Optional title for step: Ordered list.

Lead-in sentence for an ordered list:

    a. Sub-step A
    b. Sub-step B
    c. Sub-step C

3. Optional title for step: Code snippet.

Lead-in sentence explaining the code snippet. For example:

Run the prepare_ems.sh script and enter the password when prompted:

    ```bash
    cd ~/edgenius/downloads
    chmod +x prepare_ems.sh
    sudo ./prepare_ems.sh
    ```

4. Optional title for step: Conclusion.

Provide a summary of the steps completed and explain what provide result achieved by the user by completing the procedure. You can also include links to related articles that may help the reader reinforce concepts discussed in this how-to article.

**Tips and tricks**: Try to keep the number of steps between 8 and 10. If any task has more than 10 steps, think of breaking up the task into sub-tasks and adding them to "Prerequisites" or "Next steps" to guide the user to complete the task.

## See also

Include references and/or links to other related documentation, either internal to the project or external.
After a leading sentence on why/how they are valuable to readers of the current topic, multiple related links can be displayed in one or two lists:

*  One list for a small number of items, which can contain internal and external references.
*  Two lists, divided into internal and external and separated by another leading sentence, if there are a larger number of items.