Structure

Structure

Repositories

|--tutorial-compiler
|--tutorials

File system of the "tutorials" - repository

|-- tutorials
    |-- [playbook-name]
        /--index.asciidoc
        |-- images
            /--image.jpg

Write your own tutorials in "./tutorials/[playbook-name]/index.asciidoc". Images must be saved in a folder called images. You will find all the details in the tutorials Developement page.

File system of the "tutorial-compiler" - repository

Commands

Runners

|-- tutorial-compiler
    |--runners
        |--[runner]
            /--index.ts

runner

• console
• katacoda
• vscode
• wikiConsole
• wikiEclipse
• wikiEditor

Create your own commands as shown in tutorial-compilers's Developement page inside the "./index.ts"-files.

Assertions

|--tutorial-compiler
    |--assertions

Add assertions by adding a new class into the "./tutorial-compiler/assertions"-folder Learn more about it in Development

Katacoda tutorials

|-- tutorial-compiler
    |--build
        |--output
            |--katacoda
                |--[playbook-name]

You can find the generated katacoda tutorial inside "./tutorial-compiler/build/output/katacoda/[playbook-name]" You can copy the whole folder and add it to your katacoda repository.

File system inside the runners

Working directory

Console |-- tutorial-compiler |--build |--working

Katacoda |-- root

The working directory is the start directory of each runner.

Workspace directory

Workspace without devonfw IDE

Without the devonfw IDE the workspace directory equals the working directory.

|--[working-directory]

In Functions you will find the phrase "relative to workspace", which means relative to the working directory. You can set a new workspace with the function changeWorkspace.

Workspace with devonfw IDE

|--[working-directory]
    |--devonfw
        |--workspaces
            |--main

The functions

• restoreDevonfwIde
• installDevonfwIde

will change the workspace to the "[working-directory]/devonfw/workspaces/main". The phrase "relative to workspace" means in this case relative to "./main" You can set a new workspace with the function changeWorkspace.

Workspace with restoreWorkspace

The function restoreWorkspace will change the workspace.

WIthout devonfw IDE

|--[working-directory]
    |--workspaces

The phrase "relative to workspace" means in this case relative to "./workspaces"

With devonfw IDE

|--[working-directory]
    |--devonfw
        |--workspaces
            |--main

The phrase "relative to workspace" means in this case relative to "./main"