-
Notifications
You must be signed in to change notification settings - Fork 37
Development
In this section we will describe how you can implement your own tutorials.
To create a tutorial you have to use the following asciidoc syntax in */index.asciidoc (where * is the name of the playbook) :
= Headline
====
Description
====
Instructions for the step 1
[step]
--
functionName1(parameters)
--
Instructions for the step 2
[step]
--
functionName2(parameters)
--
====
Instructions for the step 3
[step]
--
functionName3(parameters)
--
Additional text
====
If you want to show additional text at the end of the step, pay attention to the syntax. You need to embed the step in '====' characters.
The generation of the tutorial is done by the tutorial-compiler (https://github.com/devonfw-forge/tutorial-compiler). You can find a description how to set up the compiler on your local machine in the tutorial-compiler repository.
https://github.com/devonfw-forge/tutorial-compiler/wiki/Setup
The easiest way to generate the tutorial is to create a pull request with your playbook in the tutorials repository. To do this, you need to fork this repository. The playbook in your pull request will automatically be build and published to https://katacoda.com/devonfw-dev.