Skip to content

Commit

Permalink
Merge branch 'staging' of https://github.com/grafana/killercoda into …
Browse files Browse the repository at this point in the history
…staging
  • Loading branch information
Jayclifford345 committed Jan 13, 2025
2 parents 29c8416 + 6009c18 commit 7c4ce68
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 16 deletions.
5 changes: 3 additions & 2 deletions sandbox-developer/sandbox-transformer-walk-through/intro.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Learn how to use the Sandbox Transformer

The Sandbox Transformer is an experimental tool created by Grafana Labs to turn **Hugo Markdown** files into KillerCoda courses. This tool is still in development, but we`re excited to share it with you and get your feedback. In this tutorial, you will learn how to use the Sandbox Transformer to turn Hugo docs into a course.
The Sandbox Transformer is an experimental tool created by Grafana Labs to turn **Hugo Markdown** files into Killercoda courses. This tool is still in development, but we're excited to share it with you and get your feedback. In this tutorial, you will learn how to use the Sandbox Transformer to turn Hugo docs into a course.

> This tutorial will also work with basic Markdown files, however, there are certain Hugo specific features such as the document metadata which is required for the transformer to work. This my interfere with the rendering of the original Markdown file.
> **Note:** This tutorial can also work with non-Hugo Markdown files but it requires that each file has certain [Hugo front matter metadata](https://gohugo.io/content-management/front-matter/).
> This front matter may interfere with the rendering of the original Markdown file.
## What you will learn

Expand Down
8 changes: 4 additions & 4 deletions sandbox-developer/sandbox-transformer-walk-through/step1.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ In this section we will cover the prerequisites you need to have in place in ord

The Sandbox Transformer is written in Go, so you will need to have Go installed on your machine. You can download Go from the official website [here](https://golang.org/dl/). In this case we will install the Ubuntu package:

1. Download the Go package:
1. Download the Go archive:

```bash
wget https://go.dev/dl/go1.23.4.linux-amd64.tar.gz
```{{exec}}
1. Remove old versions of Go and Install the package:
1. Remove old versions of Go and extract the archive:
```bash
rm -rf /usr/local/go && tar -C /usr/local -xzf go1.23.4.linux-amd64.tar.gz
```{{exec}}
1. Add the Go binary to your PATH:
1. Add the Go binary install location to your `PATH` environment variable:
```bash
export PATH=$PATH:/usr/local/go/bin
Expand All @@ -38,7 +38,7 @@ First, you need to clone the repository to your local machine. You can do this b
git clone https://github.com/grafana/killercoda.git && cd killercoda
```{{exec}}
Its best practise to create a new branch for each new course you create. You can do this by running the following command:
It's best practise to create a new branch for each new course you create. You can do this by running the following command:
```bash
git checkout -b my-new-course
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Now that you have the repository cloned and Go installed, you can build the Sand

To build the transformer:

1. navigate to the `tools/transformer`{{copy}} directory:
1. Navigate to the `tools/transformer`{{copy}} directory:

```bash
cd tools/transformer
Expand Down
3 changes: 1 addition & 2 deletions sandbox-developer/sandbox-transformer-walk-through/step3.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,7 @@ The end marker is:

Exec directives tell the transform tool to make the contained fenced code block executable.

> [!NOTE]
>
> **Note:**
> By default, the tool makes `bash`{{copy}} fenced code blocks executable so you don’t need `<!-- INTERACTIVE exec START/STOP -->`{{copy}} directives for bash code blocks.
> You can override this behavior with the `<!-- INTERACTIVE copy START/STOP -->`{{copy}} directives which take precedence over the default behavior.

Expand Down
6 changes: 3 additions & 3 deletions sandbox-developer/sandbox-transformer-walk-through/step4.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Use the Sandbox Transformer to create a course

Now that you have the transformer built and you understand the basic meta syntax, you can use the Sandbox Transformer to turn a Markdown docs into a course. Lets use one of the examples in the `docs/examples`{{copy}} directory of the `killercoda`{{copy}} repository:
Now that you have the transformer built and you understand the basic meta syntax, you can use the Sandbox Transformer to turn Markdown docs into a course. Lets use one of the examples in the `docs/examples`{{copy}} directory of the `killercoda`{{copy}} repository:

1. Navigate back to the root of the `killercoda`{{copy}} repository:

Expand Down Expand Up @@ -48,9 +48,9 @@ Now that you have the transformer built and you understand the basic meta syntax
```json
{
"items": [
"items": [
{ "path": "new-course-1", "title": "New Course 1" }
]
]
}
```{{copy}}
Expand Down
8 changes: 4 additions & 4 deletions sandbox-developer/sandbox-transformer-walk-through/step5.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Testing the course
# Test the course

Before you open a PR to the `killercoda`{{copy}} repository, you should test the course to make sure it works as expected. The easiest way to do this is to run the course via your own Killercoda instance. To do this follow these steps:

1. Fork the `killercoda`{{copy}} repository to your own GitHub account. This will provide you with a URL to your forked repository.
1. [Fork the `killercoda`{{copy}} repository](https://github.com/grafana/killercoda/fork) to your own GitHub account. This will provide you with a URL to your forked repository.

```
https://github.com/<USERNAME>/killercoda.git
Expand All @@ -29,6 +29,6 @@ Before you open a PR to the `killercoda`{{copy}} repository, you should test the
1. Create a Killercoda account: [https://killercoda.com/login](https://killercoda.com/login)
1. Then head to: [https://killercoda.com/creator/repository](https://killercoda.com/creator/repositor) and add your forked repository.
1. Then head to: [https://killercoda.com/creator/repository](https://killercoda.com/creator/repository) and add your forked repository.
1. Once saved, you should see your course in the list of courses. Click on the course to open it.
1. After you save, you should see your course in the list of courses. Click on the course to open it.

0 comments on commit 7c4ce68

Please sign in to comment.