How to submit your own Tutorial

The intention of IOTA Learn is to make it possible for anyone to submit their own content and have their projects featured so that others can build it themselves, provide input and potentially even add improvements. There is no better way to learn about a difficult new subject than actually becoming the teacher and explain what you just learned to others.

The submission format and process is aimed to be as simple as possible. Here is a basic overview of the steps that are involved in submitting your project, and the process for getting it accepted.

Screen Shot 2017-03-23 at 20.00.19.png

Note: Before you start coding

One of the most obvious questions is: what kind of projects are we looking for? The short answer is: any, as long as IOTA is part of the application. The focus of IOTA Learn is to help people get an introduction to IOTA on any difficulty level (from Beginner to Experts). The tutorial that you write to explain your application and the logic behind it is oftentimes much more important than the application itself.

Needless to say, we obviously love cool apps that display an amazing use case in the realm of Internet of Things, Machine Economy, Smart Cities and beyond. But overall you have complete freedom to code anything you want in your preferred programming language.

Project Submission

We are big advocates of open-source, therefore one of the obvious requirements is that the code for your project is published either on Github, Gitlab or similar code repository websites. Not only can others look through your code and better understand what’s going on, but they can also further contribute to your project.

Probably the most important part of your work, apart from the coding, is to actually write a tutorial about what you’ve just built. When it comes to the tutorial, we have no rigorous structure that you have to follow, but we do definitely prefer quality tutorials that make it easy for anyone to follow and understand. Usually the tutorial should be between 300 - 1000 words.

In an upcoming blog post we will provide you with more concrete guidelines on how to write your tutorial. Right now take a look at the existing tutorials and take influence from them. Once you’ve written the tutorial, upload it to either Google Docs, or Github Gist. If you use Google Docs, make sure that outsiders can comment, as this will be important for the Project Review. Usually Github Gist is better because Markdown makes it super easy to highlight code.

Now to the most interesting step: submitting your project! Head over to https://learn.iota.org/submit. We setup a very short questionnaire that you have to fill out before officially submitting your tutorial. Make sure to provide more details about yourself so that we can make people aware of who you are and get them to follow you on Github, Twitter or others.

Project Review

After you’ve submitted your project, you can relax for once. Our editorial team will look at your submission (usually within the same day), and then start formally reviewing your project.

Initially we will look at the code repository to figure out what was developed (type of application, the overall scope, category, etc.) and how it was developed (programming language, code quality, comments, etc.). After that we review your tutorial. Here we look at the overall tutorial structure, how well you explain the application and the code, and minor things such as grammar.

Overall the review process is very open and we try to be in direct contact with you to give you immediate feedback on things that need to be changed or improved. We usually expect everything to be reviewed within a couple of days.

Posting

After the review process is done and everything has been greenlit by both parties (you and our editorial team), it’s time to publish your project. Our team usually takes care of all the formatting for you and will send a final paper to you before it’s going to be officially posted.

In the official post, we will have a “About the Author” section, where we will provide more prominent information about yourself and where people can reach out to to follow you or ask for help.

And that’s pretty much everything! We’re very excited about IOTA Learn and truly want to make this a community-lead effort of co-learning and co-creation.

Quos ut hic cum labore sint.

Pariatur quis ad iure. Laudantium ut adipisci vitae repudiandae corporis. Qui laboriosam asperiores nostrum molestias eius quo quia. Deserunt nemo repellendus.

Provident nam voluptas quis sed voluptas.

Velit fugiat exercitationem rerum explicabo. Doloremque praesentium accusamus et. Suscipit tempora rerum quod.

Est sint dolorem. Facere molestiae facilis quo voluptatem. Dolor sed delectus officiis architecto fugit explicabo illo. Blanditiis ut iure maiores quia voluptatem facere veniam. Magni incidunt vitae alias.

Qui corporis magni voluptatem aperiam quam harum ratione id deleniti. Nemo molestias voluptatibus qui in. Pariatur unde iure doloribus. Illo deleniti similique.