Create Scenarios from a Github Repository

Use Github as your editor and storage for Katacoda Scenarios

Create Author Profile

Why use Katacoda?

Getting started is one of the hardest aspects of learning a new product. Katacoda's aim is to remove the effort required to learning new technologies and skills.

Pre-configured demos

Pre-configured demos

Katacoda provides a platform for companies to build interactive environments that are pre-configured with your application.

Guide your user

Guide your user

Create scenarios to help guide users to understand your product and solve their problems.

Create the best documentation

Create the best documentation

Why force users to learn CloudFormation, Vagrant or Docker to get started? Embed the environment directly into your website and documentation.

Configuration

Keep Github and Katacoda in sync via WebHooks

When changes are made to your Github Scenario Repository, a Webhook can be triggered to alert Katacoda.

Automatically Create and Configure Github Repository

Manual Steps

Step 1 - Create Github Repository

Create a new public Github Repository for your Katacoda scenarios. An example of an active repository is https://github.com/BenHall/katacoda-scenarios

Step 2 - Update Katacoda Profile

Save the URL of your Github repository on your Katacoda profile

Step 3 - Find Webhook Secret Token

Copy the Webhook Secret & save the profile.

The Katacoda Secret is used to ensure that only verified Github Repositories can update your scenarios. This can be found on your profile settings page

Step 4 - Create Github Webhook

In your Github Repository settings, add a new Github Webhook

Use the URL https://editor.katacoda.com/scenarios/updated and your copied secret.

Step 5 - Start Writing

All that's left is to start writing! An example scenario can be found at https://github.com/katacoda/scenario-example

The file index.json contains an ImageID property. This refers to the base environment. For Docker, use the ImageID docker. For Kubernetes, use kubernetes.

Each scenario should appear in their own directory. The name of the directory will become the URL for the scenario.

Step 6 - Push

Once you push your changes to the Github repository, the scenarios and updates will appear on your Katacoda profile