diff --git a/.gitignore b/.gitignore index c843aba095..478cb63d5b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,5 @@ .babelrc .cache -_templates algolia-queries.js envs gatsby-* diff --git a/README.md b/README.md index eee2e36c90..5b6f06b05b 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,22 @@ The production website is available at: ## 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 diff --git a/contribution-templates/README.md b/contribution-templates/README.md new file mode 100644 index 0000000000..9f0bca7bea --- /dev/null +++ b/contribution-templates/README.md @@ -0,0 +1,202 @@ +# Contribution to the Arduino Documentation website + +We're happy that you have found our contribution page! Here you will find everything you need to know about what you can contribute with to the Arduino Documentation website. + +***Please let us know if there is anything missing from or confusing about the contribution instructions and we'll do our best to update them.*** + +## Steps for Contribution + +1. Read this README file before going further in this list. +2. Copy the chosen template folder into the path structure of choice. See below for suggestions on where to place your content. +2. Read the README documentation on how to fill in the template. These are placed inside the corresponding template folder. +3. Read the [Arduino Style Guide](https://docs.arduino.cc/hacking/software/ArduinoStyleGuide) on how to write content. +4. Fill in your chosen template following the guidelines in the template. +5. Send in your content for review. +6. Iterate according to feedback. +7. Wait for approval. + +--- + +# What can I contribute with? + +## Bugs & Minor fixes + +The main thing you can contribute with on the Arduino Documentation repository, is the fixing of bugs, misspelling and other similar but small issues. + +***You are allowed to suggest these changes on all content available in this repository.*** + +## Adding your own content + +You are also allowed to add your own content to the Arduino Documentation repository. You are more than welcome to contribute with the following: + +|Content|Description|Example|Placement|Example Path| +|-------|-----------|-------|---------|-----| +|[Tutorial](/contribution-templates/tutorial-template)|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)|`Tutorials` folder
`Tutorial` folder inside the corresponding product|*content > tutorials*

*content > hardware > 03.nano > boards > nano-33-ble > tutorials* | +|[Article](/contribution-templates/article-template)|Learn about a specific topic.|[Multimeter Basics](https://docs.arduino.cc/learn/electronics/multimeter-basics)|`Learn`|*content > learn > 04.electronics*| +|[How To](/contribution-templates/how-to-template)|Smaller tutorial with less information and more straight to the example.|[Analog Read Serial](https://docs.arduino.cc/built-in-examples/basics/AnalogReadSerial)|`Tutorials` folder
`Tutorial` folder inside the corresponding product
`Learn`|*content > tutorials*

*content > hardware > 03.nano > boards > nano-33-ble > tutorials*

*content > learn > 04.electronics* | +|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)|`Project Hub`*|---| + +\*Note that the contributed Projects should be added to **Project Hub** instead of on the Arduino Documentation website. + +For us to be able to approve your contribution, you should follow the guidelines on how to structure and write your content. + +### Writing Content + +Please read the [Arduino Style Guide](https://docs.arduino.cc/hacking/software/ArduinoStyleGuide). + +--- + +# Documentation Style Guidelines + +## Format Guidelines + +### Tutorial Guidelines + +To write a tutorial for the Arduino Documentation website, you should follow these guidelines: + +|Section|Rules|Description|Example| +|-------|-----|-----------|-------| +|**Frontmatter**|You must fill in title, description and author. The others are voluntary.|Here is where you add the metadata of your tutorial. This is including the author, title of tutorial, compatible libraries, compatible hardware etc.|![Example of Frontmatter](_assets/frontmatter.png)| +|**Introduction**|This is an h2 heading.

You should not change the name of the heading.|The Introduction to the tutorial should be a maximum of three sentences long and be well descriptive of what the reader can expect of the tutorial.|![Example of Introduction](_assets/tut-intro.png)| +|**Goals**|This is an h2 heading.

You should not change the name of the heading.|What are the goals of this tutorial? What should the reader be able to do at the end?|![Example of Goals](_assets/tut-goals.png)| +|**Hardware & Software Needed**|This is an h2 heading.

You should not change the name of the heading.|Here you set the hardware and software you need to continue your tutorial. You are more than welcome to link the Arduino based software and hardware to the respective store or downloads page.|![Example of Hardware & Software](_assets/tut-hardware.png)| +|**Circuit/Schematic**|This is an h2 heading.

You should not change the name of the heading.|Here you add the circuits and/or schematics of your tutorial.|![Example of Circuit](_assets/tut-circuit.png)| +|**Focus Feature**|This is an h2 heading.

Here you are allowed to use as many h3 headings as you want, to be able to divide your content into easier to read sections.

You can add up to three Focus Feature headings in your tutorial.

This is the only heading you are allowed to modify.|This sections heading should be updated to the main focus of your tutorial. This is where the information about the focus start.|![Example of Focus Feature](_assets/tut-fcus.png)| +|**Programming the Board**|This is an h2 heading.

You should not change the name of the heading.|This is the section where you go through the code of your tutorial. |![Example of Programming the Board](_assets/tut-programming.png)| +|**Testing it Out**|This is an h2 heading.

You should not change the name of the heading.|This is the experimental part of your tutorial, where the reader is supposed to test out the code and focus of your tutorial.|![Example of Testing it Out](_assets/tut-testing.png)| +|**Troubleshoot**|This is an h3 heading.

You should not change the name of the heading.|If there are something in your tutorial that you know people might get stuck on, or get wrong, this is the section where you give suggestion on how the reader can troubleshoot.|![Example of Troubleshoot](_assets/tut-troubleshoot.png)| +|**Conclusion**|This is an h2 heading.

You should not change the name of the heading.|This is where you summarize your tutorial in a few sentences. What is it that you hoped to have taught or shown the reader?|![Example of Conclusion](_assets/tut-conclusion.png)| + +### How To Guidelines + +To write a How To for the Arduino Documentation website, you should follow these guidelines: + +|Section|Rules|Description|Example| +|-------|-----|-----------|-------| +|**Frontmatter**|You must fill in title, description and author. The others are voluntary.|Here is where you add the metadata of your How To. This is including the author, title of How To, compatible libraries, compatible hardware etc.

You must fill in title, description and author. The others are voluntary. **Note** that you must remove the sections in the frontmatter which are empty.|![Example of Frontmatter](_assets/frontmatter.png)| +|**Introduction**|This is an h2 heading.

You should not change the name of the heading.|The Introduction to the tutorial should be a maximum of three sentences long and be well descriptive of what the reader can expect of the How To.|![Example of Introduction](_assets/nug-intro.png)| +|**Hardware & Software Needed**|This is an h2 heading.

You should not change the name of the heading.|Here you set the hardware and software you need to continue your How To. You are more than welcome to link the Arduino based software and hardware to the respective store or downloads page.|![Example of Hardware & Software](_assets/nug-hardware.png)| +|**Circuit**|This is an h2 heading.

You should not change the name of the heading.|Here you add the circuit/s and of your How To.|![Example of Circuit](_assets/nug-circuit.png)| +|**Schematic**|This is an h2 heading.

You should not change the name of the heading.|Here you add the schematic/s and of your How To.|![Example of Schematic](_assets/nug-schematic.png)| +|**Code**|This is an h2 heading.

You should not change the name of the heading.|This is where you add your sketch code as well as the descriptive text explaining what the code does and is used for.|![Example of Code](_assets/nug-code.png)| +|**Learn more**|This is an h2 heading.

You should not change the name of the heading.|This is where you link to more information that the reader could be interested in. This could for example be other tutorials that delve deeper into the same topic, or a project that focus on the learnings of this How To.|![Example of Learn more](_assets/nug-learn.png)| + +### Article Guidelines + +To write a article for the Arduino Documentation website, you should follow these guidelines: + +|Section|Rules|Description|Example| +|-------|-----|-----------|-------| +|**Frontmatter**|You must fill in title, description and author. The others are voluntary.|Here is where you add the metadata of your article. This is including the author, title of tutorial, compatible libraries, compatible hardware etc.|![Example of Frontmatter](_assets/frontmatter.png)| +|**Introduction**|This is an h2 heading.

You should not change the name of the heading.|The Introduction should be a maximum of three sentences long and be well descriptive of what the reader can expect of the article.|![Example of Introduction](_assets/art-intro.png)| +|**Hardware & Software Needed**|This is an h2 heading.

You can modify the heading if your article only requires one of the two, either Hardware or Software.|Here you set the hardware and software you need to continue your tutorial. You are more than welcome to link the Arduino based software and hardware to the respective store or downloads page.|![Example of Hardware & Software](_assets/hardware.png)| +|**Circuit/Schematic**|This is an h2 heading.

You should not change the name of the heading.|Here you add the circuits and/or schematics of your tutorial.|![Example of Circuit](_assets/art-circuit.png)

![Example of Schematic](_assets/art-schematic.png)| + +## Markdown + +We write all of our content in markdown. To be able to contribute properly to our website, we suggest you to do the same. Practice your markdown skills here: https://commonmark.org/help/tutorial/ + +You should use the following markdown styling for our content: + +|Style|Use|Description|Example| +|-----|---|-----------|-------| +|**Bold**|\*\*bold**|Use bold when you are referring to either a path in the chosen software, or when you want to highlight a specific topic or button.|![Example use of bold](_assets/bold1.png)| +|**Inline Code**|\`code\`|Use the inline code markdown for code inside text sections.|![Example use of inline code](_assets/inline-code.png)| +|**Code Snippet**|\```arduino

this is my code

\```|Use the code snippet markdown for longer code snippets.|![Example use of code snippet](_assets/code-snippet.png)| +|**Notes**|\*\*\*Note: This is my note.***|Use the three asterisks for note tags. Note that these can’t contain line-breaks unless made with a \
tag.|![Example use of note tag](_assets/notes.png)| +|**Quotes**|\> This is a quote.|Use sparsely and with quotes only.|![Example use of quote tag]()| +|**Bullet points**|\* bullet point 1
\* bullet point 2
\* bullet point 3|Use the * or the - to make bullet points in your tutorial.

If your bullet point is a full sentence, remember to punctuate it. If your bullet point is a single word, or words not making a sentence, leave the punctuation off.|![Example use of bullet points](_assets/bullet-points.png)| +|**Numbered lists**|\*\*1.** One
\*\*2.** Two
\*\*3.** Three|Make sure to bold your numbering lists to make them format properly.|![Example use of numbered lists](_assets/numbered-list.png)| +|**Paths**|This > is > my > path|Use > when describing paths in your chosen software.|![Example use of paths](_assets/path.png)| +|**Images**|![image alternative text](relative link to image in assets folder)|Use the image tag to display images.|![Example use of images](_assets/image-tags.png)| + +***Note that we are not including cursive writing as a markdown style. We implore you not to use cursive as a means to highlight text. Instead use bold.*** + +## Trademark Guidelines + +If you want to include unit symbols or trademarked names in your content, please follow these guidelines. + +### Units + +For all unit symbols, make sure to include a space between the number and the symbol. + +Wrong: `1.75μm pixel size` + +Right: `1.75 μm pixel size` + +|Unit|Symbol| +|----|------| +|kilobyte|kB| +|megabyte|MB| +|micrometers|μm| + +***Note that this table will be updated with more examples in the future.*** + +### Trademarks + +|Trademark|Source of information| +|---------|---------------------| +|Arduino®|https://www.arduino.cc/en/trademark| +|Bluetooth® / Bluetooth® Low Energy|https://www.bluetooth.com/develop-with-bluetooth/marketing-branding/| +|Wi-Fi®|https://www.wi-fi.org/who-we-are/our-brands| +|LoRa®|https://blog.semtech.com/how-to-name-and-brand-your-lora-application| +|LoRaWAN®|https://lora-alliance.org/resource_hub/lora-alliance-marks-logo-usage-policy-and-guidelines/| +|Arm® / Cortex®|https://www.arm.com/company/policies/trademarks/arm-trademark-list| +|MathWorks®|https://www.mathworks.com/company/aboutus/policies_statements/trademarks.html| +|Microchip®|https://www.microchip.com/en-us/about/legal-information/microchip-trademarks| +|Python®|https://www.python.org/psf/trademarks/| +|Arm® Mbed™ OS|https://www.arm.com/company/policies/trademarks/arm-trademark-list/mbed-trademark| +|TensorFlow|https://www.tensorflow.org/extras/tensorflow_brand_guidelines.pdf| + +***Note that this table will be updated with more examples in the future.*** + +### Other + +These are some other naming structures that we recommend using: + +* OpenMV +* MicroPython +* OTA (Over-the-air) +* USB-_ (A/B/C) + +***Note that this list will be updated with more examples in the future.*** + + + +## Graphics + +All graphics should be **1920x1080**. All graphics are stored in an assets folder in the tutorial/article/how-to folder. See section **Naming Guidelines**. + +|Type|Purpose|Example| +|----|-------|----------| +|Circuit/Schematic|**Circuit diagrams** represent how Arduino products work with components in order to function.
A **schematic** is a stylized electronic diagram explaining electric circuits.|![Example of circuit](_assets/circuit1.png)
![Example of circuit](_assets/circuit2.png)| +|Screenshot|**Screenshots** are most often used to show the program in the Arduino IDE or any other chosen software.|![Example of screenshot](_assets/screenshot1.png)
![Example of screenshot](_assets/screenshot2.png)
![](_assets/screenshot3.png)| + + +## Naming Guidelines + +### Files + +Name the folder after the title of your documentation. The name of the folder should contain a maximum of 4 words divided by dashes. + +`connector-basics` + +`SoftwareSerialExample` + +![Naming of tutorial folder](_assets/tutorial-folder.png) + +The folder should then contain an assets folder, as well as the main content markdown file. It’s important to name the main content file the same name as the folder. + +`connector-basics.md` + +`SoftwareSerialExample.md` + +![Naming and formatting of tutorial folder](_assets/tutorial-folder2.png) + +### Images + +There is no specific way you need to name the images, however it is a good practice to add something descriptive in the name. Also remember to divide words by using dashes. + +`UNO-Mini-LE-external-power.png` + +`rp2040-ap-mode-img-01.png` diff --git a/contribution-templates/_assets/art-circuit.png b/contribution-templates/_assets/art-circuit.png new file mode 100644 index 0000000000..b751e51adb Binary files /dev/null and b/contribution-templates/_assets/art-circuit.png differ diff --git a/contribution-templates/_assets/art-intro.png b/contribution-templates/_assets/art-intro.png new file mode 100644 index 0000000000..744682ca0d Binary files /dev/null and b/contribution-templates/_assets/art-intro.png differ diff --git a/contribution-templates/_assets/art-schematic.png b/contribution-templates/_assets/art-schematic.png new file mode 100644 index 0000000000..420a17ae57 Binary files /dev/null and b/contribution-templates/_assets/art-schematic.png differ diff --git a/contribution-templates/_assets/bold1.png b/contribution-templates/_assets/bold1.png new file mode 100644 index 0000000000..63a18f7917 Binary files /dev/null and b/contribution-templates/_assets/bold1.png differ diff --git a/contribution-templates/_assets/bullet-points.png b/contribution-templates/_assets/bullet-points.png new file mode 100644 index 0000000000..2cec348df9 Binary files /dev/null and b/contribution-templates/_assets/bullet-points.png differ diff --git a/contribution-templates/_assets/circuit1.png b/contribution-templates/_assets/circuit1.png new file mode 100644 index 0000000000..7ab62aab68 Binary files /dev/null and b/contribution-templates/_assets/circuit1.png differ diff --git a/contribution-templates/_assets/circuit2.png b/contribution-templates/_assets/circuit2.png new file mode 100644 index 0000000000..8d512e24ff Binary files /dev/null and b/contribution-templates/_assets/circuit2.png differ diff --git a/contribution-templates/_assets/code-snippet.png b/contribution-templates/_assets/code-snippet.png new file mode 100644 index 0000000000..2d8c522532 Binary files /dev/null and b/contribution-templates/_assets/code-snippet.png differ diff --git a/contribution-templates/_assets/frontmatter.png b/contribution-templates/_assets/frontmatter.png new file mode 100644 index 0000000000..04ae45f48a Binary files /dev/null and b/contribution-templates/_assets/frontmatter.png differ diff --git a/contribution-templates/_assets/hardware.png b/contribution-templates/_assets/hardware.png new file mode 100644 index 0000000000..50290652ae Binary files /dev/null and b/contribution-templates/_assets/hardware.png differ diff --git a/contribution-templates/_assets/image-tags.png b/contribution-templates/_assets/image-tags.png new file mode 100644 index 0000000000..748c488aed Binary files /dev/null and b/contribution-templates/_assets/image-tags.png differ diff --git a/contribution-templates/_assets/inline-code.png b/contribution-templates/_assets/inline-code.png new file mode 100644 index 0000000000..353b9b3f9e Binary files /dev/null and b/contribution-templates/_assets/inline-code.png differ diff --git a/contribution-templates/_assets/notes.png b/contribution-templates/_assets/notes.png new file mode 100644 index 0000000000..85580e562c Binary files /dev/null and b/contribution-templates/_assets/notes.png differ diff --git a/contribution-templates/_assets/nug-circuit.png b/contribution-templates/_assets/nug-circuit.png new file mode 100644 index 0000000000..99e11b37b9 Binary files /dev/null and b/contribution-templates/_assets/nug-circuit.png differ diff --git a/contribution-templates/_assets/nug-code.png b/contribution-templates/_assets/nug-code.png new file mode 100644 index 0000000000..c69d32e402 Binary files /dev/null and b/contribution-templates/_assets/nug-code.png differ diff --git a/contribution-templates/_assets/nug-hardware.png b/contribution-templates/_assets/nug-hardware.png new file mode 100644 index 0000000000..70fc48016d Binary files /dev/null and b/contribution-templates/_assets/nug-hardware.png differ diff --git a/contribution-templates/_assets/nug-intro.png b/contribution-templates/_assets/nug-intro.png new file mode 100644 index 0000000000..b1e5a02cad Binary files /dev/null and b/contribution-templates/_assets/nug-intro.png differ diff --git a/contribution-templates/_assets/nug-learn.png b/contribution-templates/_assets/nug-learn.png new file mode 100644 index 0000000000..9f6fff8d64 Binary files /dev/null and b/contribution-templates/_assets/nug-learn.png differ diff --git a/contribution-templates/_assets/nug-schematic.png b/contribution-templates/_assets/nug-schematic.png new file mode 100644 index 0000000000..f92b1a888c Binary files /dev/null and b/contribution-templates/_assets/nug-schematic.png differ diff --git a/contribution-templates/_assets/numbered-list.png b/contribution-templates/_assets/numbered-list.png new file mode 100644 index 0000000000..6f92a39c1e Binary files /dev/null and b/contribution-templates/_assets/numbered-list.png differ diff --git a/contribution-templates/_assets/path.png b/contribution-templates/_assets/path.png new file mode 100644 index 0000000000..749ce69cd7 Binary files /dev/null and b/contribution-templates/_assets/path.png differ diff --git a/contribution-templates/_assets/screenshot1.png b/contribution-templates/_assets/screenshot1.png new file mode 100644 index 0000000000..85fe7686c6 Binary files /dev/null and b/contribution-templates/_assets/screenshot1.png differ diff --git a/contribution-templates/_assets/screenshot2.png b/contribution-templates/_assets/screenshot2.png new file mode 100644 index 0000000000..5faca04078 Binary files /dev/null and b/contribution-templates/_assets/screenshot2.png differ diff --git a/contribution-templates/_assets/screenshot3.png b/contribution-templates/_assets/screenshot3.png new file mode 100644 index 0000000000..8ba5fb5329 Binary files /dev/null and b/contribution-templates/_assets/screenshot3.png differ diff --git a/contribution-templates/_assets/tut-circuit.png b/contribution-templates/_assets/tut-circuit.png new file mode 100644 index 0000000000..9065b0a083 Binary files /dev/null and b/contribution-templates/_assets/tut-circuit.png differ diff --git a/contribution-templates/_assets/tut-conclusion.png b/contribution-templates/_assets/tut-conclusion.png new file mode 100644 index 0000000000..d474c8426a Binary files /dev/null and b/contribution-templates/_assets/tut-conclusion.png differ diff --git a/contribution-templates/_assets/tut-fcus.png b/contribution-templates/_assets/tut-fcus.png new file mode 100644 index 0000000000..d1adece35b Binary files /dev/null and b/contribution-templates/_assets/tut-fcus.png differ diff --git a/contribution-templates/_assets/tut-goals.png b/contribution-templates/_assets/tut-goals.png new file mode 100644 index 0000000000..29c3dd174e Binary files /dev/null and b/contribution-templates/_assets/tut-goals.png differ diff --git a/contribution-templates/_assets/tut-hardware.png b/contribution-templates/_assets/tut-hardware.png new file mode 100644 index 0000000000..f0385d980b Binary files /dev/null and b/contribution-templates/_assets/tut-hardware.png differ diff --git a/contribution-templates/_assets/tut-intro.png b/contribution-templates/_assets/tut-intro.png new file mode 100644 index 0000000000..e4821de6b5 Binary files /dev/null and b/contribution-templates/_assets/tut-intro.png differ diff --git a/contribution-templates/_assets/tut-programming.png b/contribution-templates/_assets/tut-programming.png new file mode 100644 index 0000000000..30d87e68c8 Binary files /dev/null and b/contribution-templates/_assets/tut-programming.png differ diff --git a/contribution-templates/_assets/tut-testing.png b/contribution-templates/_assets/tut-testing.png new file mode 100644 index 0000000000..f94ebb8525 Binary files /dev/null and b/contribution-templates/_assets/tut-testing.png differ diff --git a/contribution-templates/_assets/tut-troubleshoot.png b/contribution-templates/_assets/tut-troubleshoot.png new file mode 100644 index 0000000000..0eb5a1aaf2 Binary files /dev/null and b/contribution-templates/_assets/tut-troubleshoot.png differ diff --git a/contribution-templates/_assets/tutorial-folder.png b/contribution-templates/_assets/tutorial-folder.png new file mode 100644 index 0000000000..f6a8e2dae9 Binary files /dev/null and b/contribution-templates/_assets/tutorial-folder.png differ diff --git a/contribution-templates/_assets/tutorial-folder2.png b/contribution-templates/_assets/tutorial-folder2.png new file mode 100644 index 0000000000..c919176fb9 Binary files /dev/null and b/contribution-templates/_assets/tutorial-folder2.png differ diff --git a/contribution-templates/article-template/article-template.md b/contribution-templates/article-template/article-template.md new file mode 100644 index 0000000000..f9017f3c4b --- /dev/null +++ b/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) \ No newline at end of file diff --git a/contribution-templates/how-to-template/how-to-template.md b/contribution-templates/how-to-template/how-to-template.md new file mode 100644 index 0000000000..ccadd6d9e5 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/contribution-templates/tutorial-template/tutorial-template.md b/contribution-templates/tutorial-template/tutorial-template.md new file mode 100644 index 0000000000..e26c438f89 --- /dev/null +++ b/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. +