tutorial done

jacmet · Nov 21, 2019 · 41095b4 · 41095b4
1 parent c4deb83
commit 41095b4
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 11 deletions.
diff --git a/Components.md b/Components.md
@@ -15,7 +15,7 @@ If you wish to expand a device with a [peripheral](Peripherals) component, after
 
 Read more about [peripherals](Peripherals).
 
-### Components List
+## Components List
 [Google Sheet](https://docs.google.com/spreadsheets/d/10aYCaR3P09omn_vryFGyyq7dS-XK54K2fGAcb4gruik) of components by number and alphabetically
 
 |#|Name|Description

diff --git a/Contributing.md b/Contributing.md
@@ -7,20 +7,36 @@ We need:
 - new device templates 
 - fixing spelling mistakes, broken links and other errors in the Wiki
 
-***Please do not edit the sidebar links unless it's a broken link*** 
+The information available is still needed for devices in the field (like Shelly 2) and loss of information makes them unusable in case of debugging or fault analysis.
 
-# Removing information
+### Writing guides
+Whenever you feel is a good guide or an article that would help other users just click the New Page icon and write.
 
-***Do not remove information about deprecated or discontinued devices.***
+### Adding devices to the documentation
+All new devices should be submitted through the [Templates Repository](http://blakadder.github.io/templates). If you're adding a device with a comprehensive flashing or configuration tutorial you can create a new page in the Wiki and link to it in your template submission.
 
-The information available is still needed for devices in the field (like Shelly 2) and loss of information makes them unusable in case of debugging or fault analysis.
+## Editing articles
+If you spot an error in an article use the *Improve this article* link at the top of the page to correct it. 
 
-# Adding devices to the wiki
+> [!WARNING]
+> You need a GitHub user account to be able to edit!
 
-All new devices should be submitted through the [Templates Repository](http://blakadder.github.io/templates). If you're adding a device with a comprehensive flashing or configuration tutorial you can create a new page in the Wiki and link to it in your template submission.
+You'll be taken to the GitHub repository page of that file.
 
-# Editing the wiki
-If you spot an error in an article use the *Edit* function to correct it. Make sure you write a short description on what you've changed in *Edit message* input box before clicking *Save page*.
+![Edit file](_media/pr_tutorial_1.png)
 
-# Writing guides
-Whenever you feel is a good guide or an article that would help other users just click the New Page icon and write.
+Click on the **edit** button (pencil icon). Edit/Add the text you wanted. When finished find the **Propose file change** button at the bottom and click it.
+
+![Propose file change](_media/pr_tutorial_2.png)
+
+Next you need to click **Create pull request** which is GitHub speak for propose changes.
+![Create pull request](_media/pr_tutorial_3.png)
+
+In the PR window add a small description of what you did and click **Create pull request**
+![Create pull request](_media/pr_tutorial_4.png)
+
+Now you wait for one of the Tasmota admins to approve your PR. 
+
+_**Congratulations**_! 
+
+You've made a contribution to the Tasmota project making it a better experience for all future users. Thank you!
diff --git a/_media/pr_tutorial_1.png b/_media/pr_tutorial_1.png
diff --git a/_media/pr_tutorial_2.png b/_media/pr_tutorial_2.png
diff --git a/_media/pr_tutorial_3.png b/_media/pr_tutorial_3.png
diff --git a/_media/pr_tutorial_4.png b/_media/pr_tutorial_4.png