Difficulty: Beginner
Estimated Time: 10 minutes

In this scenario, you will learn how to create your first Katacoda scenario. It will explain the essential aspects and the design decisions that you need to be aware of.

Congratulations. You have completed the scenario on the foundations of creating Katacoda content. Continue looking at examples on katacoda.com/scenario-examples

Creating Your First Katacoda Scenario

Step 1 of 5

Step 1 - Scenario Structure

A Katacoda scenario is a series of Markdown files, bash scripts and a JSON file to define how your scenario should be configured, the text for the scenario and any automation required.

Task

Clone our example repository that contains the set of documentation with the following command:

git clone https://github.com/katacoda/scenario-examples.git katacoda-scenario-examples

Within the repository, you will see a set of examples of implementing various Katacoda functionality.

The scenario you are currently reading is in the directory ls -lha katacoda-scenario-examples/create-scenario-101. The directory name is what defines the URL.

An example of the current step is katacoda-scenario-examples/create-scenario-101/step1.md

All the steps are collected via a JSON file, for example, katacoda-scenario-examples/create-scenario-101/index.json.

The JSON file defines the scenario title, the description, steps order, the UI layout and environment. You can find more about the layouts within our scenarios at katacoda.com/scenario-examples/ui-layouts and environments at katacoda.com/scenario-examples/environments.