diff --git a/template-tutorial.adoc b/template-tutorial.adoc deleted file mode 100644 index f28efbb..0000000 --- a/template-tutorial.adoc +++ /dev/null @@ -1,46 +0,0 @@ -# fire-detection-in-video-with-pytroch - -// Describe the title of your article by replacing "Tutorial template" with the page name you want to publish to in Confluence. -= Tutorial template -// Article variables (delete the `// comments` and add in the values) -:description: // Summarise what this tutorial is about in a sentence or two. What you put here is reused in the Goal section and included in HTML description tags. -:keywords: // These are comma-separated tags. -:experimental: // Enables UI Macros for Menu transitions and Keyboard shortcuts. - -== Goal - -{description} - -== Before you start -// Delete this section if your readers can dive straight into the lesson without requiring any prerequisite knowledge. -Make sure you meet the following prerequisites before starting the tutorial steps: - -* Prerequisite one -* Prerequisite two -* etc - -''' - -== Part 1 - - -//// -Introduce what your audience will learn in this step, then continue to write the steps in the tutorial. -You can choose one of these approaches to write your tutorial part: - -* In a narrative style if your parts are short or you are using screenshots to do most of the talking.    -* In a "Goal > Steps > Outcome" structure to build a predictable flow in all your tutorial parts. - -Whatever option you choose when designing your tutorial should be carried through in subsequent parts. -//// - -== Part 2 - - -//// -Continue the design approach you chose in the previous part and continue it through to the end of the tutorial. -//// - -== What you've learned - -//// -Summarise what knowledge the reader has gained by completing the tutorial, including a summary of each part's Goals (this is a good way to validate whether your tutorial has covered all you need it to.) -//// diff --git a/tutorial.md b/tutorial.md new file mode 100644 index 0000000..40f69e0 --- /dev/null +++ b/tutorial.md @@ -0,0 +1,62 @@ +# fire-detection-in-video-with-pytroch + + + +# How-to template + +## Overview + +Summarise 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?". +Readers who are reading tasks are engaging in a learning behavior. + +Readers should already have read a concept about the topic in an About article. +Ensure you link to the relevant About article here. + + +**Keywords:** Optionally add comma-separated keywords. + +## Before you start + +Make sure you meet the following prerequisites before starting the how-to steps: + +* Prerequisite one +* Prerequisite two +* etc + +Include other important information here too, such as known issues or bugs. + +## Step-by-step guide + +### Step 1: Optional: Title for step - image or screenshot + + + +![alt text](https://upload.wikimedia.org/wikipedia/commons/3/35/Tux.svg "Image title which describes image.") + +Brief instructions explaining how to interpret the image. + +### Step 2: Optional: title for step - ordered list + +Lead-in sentence for an ordered list: + +1. Substep A +1. Substep B +1. Substep C + +### Step 3: Optional: title for step - code snippet + +Lead-in sentence explaining the code snippet. For example: + +Run the `apt` command to install the Asciidoctor package and check the version. + +``` +$ sudo apt install asciidoctor + +$ asciidoctor --version +Asciidoctor 1.5.6.2 [https://asciidoctor.org] +``` + +### Step 4: Optional: title for step - Conclusion + +Provide a summary of the steps completed and explain what the user has achieved by following them. You can also include links to related articles that may help the reader reinforce concepts discussed in this how-to article.