Templates for Contribution [MKC-359]

.gitignore

@@ -1,6 +1,5 @@
 .babelrc
 .cache
-_templates
 algolia-queries.js
 envs
 gatsby-*

README.md

@@ -9,11 +9,22 @@ The production website is available at: <https://docs.arduino.cc>
 ## How Can I Contribute?
 
 Contributing by creating content or suggestion changes to existing content can be done by making **pull requests**.
+
 You start by forking the repository or by creating a new branch if you have write access to this repo. Create a new branch based on main and name it according to what you will create prefixed with your github username and a slash (e.g. `sebromero/wifi-tutorial`). Read in the section below how to add different types of new content.
 
 When you're done with a draft you can create a pull request. This will give the content team the possibility to review it and leave comments or request changes. During this review process you can continue to push commits to the same branch. They will show up in the pull request automatically.
+
 Once the pull request gests approved and merged into main, the content will be deployed to the live server.
 
+There are four different content types you can contribute with. These are **tutorial**, **article**, **how to** and **project**. Please read more on what they mean and how to write one in the [Contribution Templates folder](/contribution-templates/README.md).
+
+|Content|Description|Example|
+|-------|-----------|-------|
+|Tutorial|Learn how to do something.|[Control Built-in RGB LED over Wi-Fi with Nano RP2040 Connect](https://docs.arduino.cc/tutorials/nano-rp2040-connect/rp2040-web-server-rgb)|
+|Article|Learn about a specific topic.|[Multimeter Basics](https://docs.arduino.cc/learn/electronics/multimeter-basics)|
+|How To|Smaller tutorial with less information and more straight to the example.|[Analog Read Serial](https://docs.arduino.cc/built-in-examples/basics/AnalogReadSerial)|
+|Project|Learn how to build something.|[DIY Photoshop Editing Console using Arduino Nano RP2040 Connect](https://create.arduino.cc/projecthub/jithinsanal1610/diy-photoshop-editing-console-using-arduino-nano-rp-2040-a43e97?ref=search&ref_id=nano%20rp2040%20connect&offset=0)|
+
 ## Fixing Bugs and Typos
 
 If you found a mistake in the content you need to locate the corresponding file to fix it and create a pull request. Here is how to locate the content.
@@ -37,7 +48,7 @@ If you found a mistake in the content you need to locate the corresponding file
 
 ### Software
 
-- If you found an issue in a sofware product's tutorial they are located according to the following pattern:
+- If you found an issue in a software product's tutorial they are located according to the following pattern:
   `/content/software/[product-name]/tutorials/(tutorial-subfolder)/[tutorial-name]/[content-file].md`
 
 ## Adding Content

contribution-templates/article-template/article-template.md

@@ -0,0 +1,43 @@
+---
+title: 'Article Template'
+description: 'This is the template for creating an article for the Arduino Documentation website.'
+tags: 
+  - article
+author: 'Arduino'
+---
+
+## Introduction
+
+Write a short introduction to the article. Consider this to be an abstract that should summarize the content of this article.
+
+Note that **plagiarism is unacceptable**, and we encourage you to provide references used to produce your article. These can be listed under the **"References"** section at the bottom of this article. Plagiarised work will be removed immediately.
+
+## Hardware & Software Needed (Optional)
+
+***This section is optional, since articles may not directly include the use of an Arduino board or the software.***
+
+List the hardware and software needed. This could be the IDEs, libraries but also the hardware such as the board for example. Make sure to link to whatever you are listing. 
+
+- Arduino IDE ([online](https://create.arduino.cc/) or [offline](https://www.arduino.cc/en/main/software)).
+- [Arduino Nano RP2040 Connect](https://store.arduino.cc/nano-rp2040-connect).
+- etc.
+
+## Section 1
+
+Free format section.
+
+## Section 2
+
+Free format section.
+
+## Section 3
+
+Free format section.
+
+## Conclusion
+
+A summary of your article.
+
+## References
+
+- [Arduino (Wikipedia)](https://en.wikipedia.org/wiki/Arduino)

contribution-templates/how-to-template/how-to-template.md

@@ -0,0 +1,50 @@
+---
+title: 'How To Template'
+description: 'This is the template for creating a How To article for the Arduino Documentation website.'
+tags: 
+  - tutorial
+author: 'Arduino'
+libraries: 
+  - name: Arduino PDM
+    url: https://www.arduino.cc/en/Reference/PDM
+hardware:
+  - hardware/03.nano/boards/nano-rp2040-connect
+software:
+  - ide-vi
+  - ide-v2
+  - web-editor
+  - iot-cloud
+---
+
+Update the frontmatter above with information that fits your article. Remove the section that are not relevant or filled in. Note that you **must** at least fill in the title, description and author. Remove the sections that are not filled in.
+
+## Introduction
+
+Write a short introduction to the How To. This should be maximum three sentences long and summarize what the How To is about. 
+
+## Hardware & Software Required
+
+List the hardware and software needed. This could be the IDEs, libraries but also the hardware such as the board for example. Make sure to link to whatever you are listing. 
+
+- Arduino IDE ([online](https://create.arduino.cc/) or [offline](https://www.arduino.cc/en/main/software)).
+- [Arduino Nano RP2040 Connect](https://store.arduino.cc/nano-rp2040-connect).
+
+## Circuit
+
+Add the image of the circuit here. This section should not need any text following the image, only a well thought alternative image text. 
+
+![Well thought out alternative image text.]()
+
+## Schematic
+
+Add the image of the schematic here. This section should not need any text following the image, only a well thought alternative image text. 
+
+![Well thought out alternative image text.]()
+
+## Code
+
+Example code for the reader to copy and paste into their own sketch. This section should explain the different sections in the code. 
+
+## Learn more
+
+Information on how the reader could delve deeper into the topic. For example linking to other tutorials or projects. 

contribution-templates/tutorial-template/tutorial-template.md

@@ -0,0 +1,73 @@
+---
+title: 'Tutorial Template'
+description: 'This is the template for creating a tutorial for the Arduino Documentation website.'
+tags: 
+  - tutorial
+author: 'Arduino'
+libraries: 
+  - name: Arduino PDM
+    url: https://www.arduino.cc/en/Reference/PDM
+hardware:
+  - hardware/03.nano/boards/nano-rp2040-connect
+software:
+  - ide-v1
+  - ide-v2
+  - web-editor
+  - iot-cloud
+---
+
+Update the frontmatter above with information that fits your tutorial. Remove the section that are not relevant or filled in. Note that you **must** at least fill in the title, description and author. Remove the sections that are not filled in.
+
+## Introduction 
+
+Write a short introduction to the tutorial. This should be maximum three sentences long and summarize what the tutorial is about. 
+
+## Goals
+
+List here the goals of this tutorial. Try to keep it short, approx. 3-5 bullets. 
+
+The goals of this tutorial are:
+
+- 
+
+## Hardware & Software Needed
+
+List the hardware and software needed. This could be the IDEs, libraries but also the hardware such as the board for example. Make sure to link to whatever you are listing. 
+
+- Arduino IDE ([online](https://create.arduino.cc/) or [offline](https://www.arduino.cc/en/main/software)).
+- [Arduino Nano RP2040 Connect](https://store.arduino.cc/nano-rp2040-connect).
+- etc.
+
+## Circuit
+
+Add the image of the circuit here. This section should not need any text following the image, only a well thought alternative image text. 
+
+![Well thought out alternative image text.]()
+
+## Focus Feature
+
+This is the **only** heading you should rename to what the feature is about. Talk about the first feature you want this tutorial to highlight. You can use step-by-step instructions, images or code snippets to show examples. You can use subheading h3 here as well. 
+
+You can also add how many of the "Focus Feature" headings as needed, however as tutorials only focus on minimal features, we recommend to only adding a maximum of three "Focus Feature" headings.
+
+## Programming the Board
+
+Example code for the reader to copy and paste into their own sketch. This section should explain the different sections in the code. 
+
+## Testing It Out
+
+After uploading the code, we should now start using it. Go through the flow with the reader. 
+
+### Troubleshoot
+
+Add a bullet list of the things that could be the potential issue for something not working. 
+
+If the code is not working, there are some common issues we can troubleshoot:
+
+- Troubleshoot point 1
+- Troubleshoot point 2
+
+## Conclusion
+
+Add a conclusion to what this tutorial has gone through. Connect back to what you wrote in the "Goals" section. 
+