Tutorial title
Prerequisites
Yagna service is installed and running with the try_golem
app-key configured.
Introduction
This tutorial will lead you through the steps required to create a tutorial on the Golem Network.
We will go through the following steps:
- Explain the aim of the tutorial
- Tell you a little about the structure
- Add some other points
As the "good pattern" aspect is important, tutorials should also illustrate the practical aspect - how to organize things and how to overcome common challenges.
In this section, we should also explain to users how they can benefit from doing this tutorial, and, if we know, how much time it should take to complete.
Lastly, what the readers should do when they have a problem.
What is in for me/What will I gain?
You can create such a subsection.
Explain the aim of the tutorial
A tutorial should lead the readers step by step, to achieve some defined output. The steps should be designed to show a complete and successful path. The output should have a meaning - it should have some practical value.
Tutorial users should be able to repeat the step for any other challenges to resolve their problem. As such, the process should show the desired sequence and practices. The user should be able to do sth independently by modifying the steps or output files.
There is no defined border on how much we should explain the non-Golem aspects. You need to decide yourself how much external knowledge you will include in the tutorial, and what you will assume is known or can be acquired by readers themselves. In case of doubts, you can add an entry in the prerequisites section or you can add a link to 3rd party pages.
For more information on this topic, see the complete reference
Tell readers more about the tutorial structure.
You can skip this section if you know the structure of the next topic
A tutorial should have visible steps, each step should be explained, why it is needed, and what will be achieved in that step.
Steps can have smaller little milestones.
You should gradually add new content and make sure that the reader will know how to add it to the content created in previous steps.
You can provide a reference to the final output
If you get lost, you can copy the final solution from here:
console.log('solution')
of from our github pages
Add some other points
Tutorials should not focus on showing the alternatives but rather focus on the right sequence and good practice on a successful path. You can use tutorials to explain the reasons for decisions taken and the consequences.
Note that we will improve the content of this tutorial based on the authors' input.
If a user can make an error, or a command creates a risk, you can use warning or danger alerts!
Run the code and show the output
Note that this point is not on the agenda, and this is not a good practice.
Before running make sure: Remind the readers about the prerequisites: What services should be running What has been created so far
Summary
In this tutorial, the reader what he has done and what he achieved:
- Explain the aim of the tutorial
- Tell a little about the structure
- Add some other points
- Title of other related sections: i.e. Tutorials, Guides.
Was this helpful?