Skip to content
Snippets Groups Projects
Commit 5e44f8c1 authored by francisco's avatar francisco :penguin:
Browse files

Refine instructions and simplify template

parent 4f363a47
No related branches found
No related tags found
No related merge requests found
# FabAcademy-Tutorials
A living collection of tutorials to support Fab Academy, hosted in the [Academany Github respository](https://github.com/Academany/FabAcademy-Tutorials).
*Created by Fab Academy instructors/students around the world*
### Tutorials Guide - How do I contribute?
**01.** Create a [github](https://github.com/) account if you don't have already one.
**02.** [FORK](https://help.github.com/articles/fork-a-repo/) the *academany tutorials repo* you can find it [HERE](https://github.com/Academany/FabAcademy-Tutorials)
**03.** Write your tutorial using [markdown](https://en.wikipedia.org/wiki/Markdown). If it is your first time we have included a [TEMPLATE](template.md) and a [markdown_guide](markdown_guide.md) to help you. (Your can use your normal text editor like [Atom](https://atom.io/), [Sublime](http://www.sublimetext.com/), [Brackets](http://brackets.io/), [Notepad++](https://notepad-plus-plus.org/))
**04.** Check at the bottom of the page to see the *GUIDE OF TUTORIAL DOCUMENTING*
**05.** Once you are done.[Create a pull request](https://help.github.com/articles/creating-a-pull-request/) to have your tutorial/guide approved by the mighty instructors.
**06.** Enjoy your tutorial in the [tutorials gitbook](http://docs.academany.org/FabAcademy-Tutorials/_book/)and [thanks](https://upload.wikimedia.org/wikipedia/commons/3/30/DcvfThank-you-1.jpg) for your contribution.
**GUIDE OF TUTORIAL DOCUMENTING**
* If you want to add a tutorial, go to the [github](https://github.com/Academany/FabAcademy-Tutorials) to add it and ask to merge.
* You will find a folder for each week/assignment tutorial.
* Use the template for creating a new tutorial and keep it simple. LESS IS MORE.
* Your tutorial naming must clarify the OS and language used in the tutorial. example: *shopbot_windows_english.md*
* Create a folder containing your tutorial images and use the same naming as in it.
* Recommended images size is 800x600 and 72-150 ppi.
* If you have "side files" embed them in your respective tutorial image folder
* Prioritize the creation of English tutorials (so everybody can use them)
* If it is your first time with MARKDOWN language use this [guide](markdown_guide.md)
* Don't leave the first line of code empty of gitbook will not index your tutorial.
> Don't rely on a single tutorial. Check the the multiple tutorials and look for other resources.
Changes will be made to this document thoughout Fab Academy, additions are always welcome but *don't duplicate information, just update the tutorials.*
# FabAcademy - Tutorials
A living collection of tutorials created by Fab Academy instructors/students around the world to support Fab Academy. Don't rely on a single tutorial. Check the the multiple tutorials and look for other resources.
## How do I contribute?
Additions are always welcome, but if you are creating a modified version of a tutorial, don't duplicate information. Just update the existing tutorials.
Tutorials can be created in any language, but use of English is strongly encouraged for maximum diffusion.
1. Create a [github](https://github.com/) account if you don't have already one.
2. [Fork](https://help.github.com/articles/fork-a-repo/) the [FabAcademy-Tutorials repository](https://github.com/Academany/FabAcademy-Tutorials)
3. You will find a folder for each week/assignment. Create your tutorial inside the corresponding assignment folder.
5. Your tutorial name must clarify the OS and language used in the tutorial. Example: `shopbot_windows_english.md`
6. Write your tutorial using [Markdown](https://en.wikipedia.org/wiki/Markdown). If it is your first time writing in Markdown follow [this tutorial](http://www.markdowntutorial.com/). Your can use any text editor like [Atom](https://atom.io/), [Sublime](http://www.sublimetext.com/), [Brackets](http://brackets.io/), or [Notepad++](https://notepad-plus-plus.org/)
7. We have provided a [template](template.md) for creating new tutorials in case you need a guideline.
* If you need to host images or files, create a folder next to your tutorial using the same name as the tutorial (example `shopbot_windows_english`). Put your images and files inside it. Recommended images size is 800x600 pixels.
8. Keep it simple. Less is more.
9. Once you are done. [Create a pull request](https://help.github.com/articles/creating-a-pull-request/) to have your tutorial approved by the mighty instructors.
10. Once approved you can read your tutorial in the [tutorials gitbook](http://docs.academany.org/FabAcademy-Tutorials/_book/)
11. [Thanks](https://upload.wikimedia.org/wikipedia/commons/3/30/DcvfThank-you-1.jpg) for your contribution!
# MARKDOWN GUIDE
# title1
## title2
### title3
* list of elements
*italic text*
**bold text**
[text with links](www.google.com)
![image](image.jpg)
>quoted text
# YOUR TUTORIAL TITLE
# Tutorial title
- Original tutorial by: John Doe
- Your lab name: Moon Lab
- License: CC-SA-BY
- Last Review Date: 01/12/2016
- Last Modified by: Agent Smith
## Short description of the tutorial itself and a Hero shot of the assignment.
![image](yourtutorialnamefolder/1.jpg)
## Summary
Short description of the tutorial itself and a representative image of the tutorial.
**Summary:**
* [Link](example web address)
* STEP BY STEP SHORT DESCRIPTION
*
*
*
*
### Step 1 (DESCRIPTION OF THE STEP)
## Step 1. Description of the step
Text explaining what to do.
* List of elements/tools
*
*
Links for other sources/ useful information [link](example link)
[link](example link)
### Step 2: (DESCRIPTION OF THE STEP) *clarifier*
## Step 2. Description of the step
Text explaining what to do.
![image](yourtutorialnamefolder/1.jpg)
[![Embedded Video](https://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg)](https://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)
[Video Link](https://youtubevideourl)
>IMPORTANT STEP NOT TO MISS
* Value or settings for software/machine
* x0(mm) - *0*
* y0(mm) - *0*
* z0(mm) - *0*
*Clarifier on the settings*
Click **"calculate"**
>Explanation of an important action
![image](yourtutorialnamefolder/5.jpg)
**FINISH TUTORIAL - Enjoy your WELL DONE assignment and clean your mess and files after you're done !**
## Problems faced and solutions
### COMMON PROBLEMS/SOLUTIONS
- First Problem description
- PROBLEM 1
> Solution found
>SOLUTION 1
>SOLUTION2
- Second Problem description
- PROBLEM 2
> Solution found
>SOLUTION 1
>SOLUTION2
## Machines and software used and settings
**Original tutorial by:**
* Machine used
* Spindle Speed
* Feed Rate
* Power
* [Your name](link to your site)
Your lab name | v1.0 | date
## Links for other sources / useful information
- [Link 1]()
- [Link 2]()
* Updated by...
## Original Design files
* [CAD file]()
* [Electronics Schematic]()
* [Electronics board]()
* [Code]()
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment