Add tool and workflow to generate and regenerate tutorials from documentation

.github/workflows/blank.yml

@@ -1,36 +1,35 @@
-# This is a basic workflow to help you get started with Actions
-
-name: CI
-
-# Controls when the workflow will run
+name: Regenerate tutorials
 on:
-  # Triggers the workflow on push or pull request events but only for the "main" branch
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-
-  # Allows you to run this workflow manually from the Actions tab
+  schedule:
+    - cron: '0 7 * * 1-5'
   workflow_dispatch:
-
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  # This workflow contains a single job called "build"
-  build:
-    # The type of runner that the job will run on
+  main:
+    if: github.repository == 'grafana/killercoda'
     runs-on: ubuntu-latest
-
-    # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v4
-
-      # Runs a single command using the runners shell
-      - name: Run a one-line script
-        run: echo Hello, world!
-
-      # Runs a set of commands using the runners shell
-      - name: Run a multi-line script
-        run: |
-          echo Add other actions to build,
-          echo test, and deploy your project.
+        with:
+          repository: grafana/loki
+          # Change to `main` after this branch is merged.
+          ref: jdb/2024-06-killercoda-migration
+          path: loki
+      - uses: actions/checkout@v4
+        with:
+          ref: jdb/2024-06-killercoda-migration
+          path: killercoda
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: killercoda/tools/transformer/go.mod
+      - run: go build ./
+        working-directory: killercoda/tools/transformer
+      - run: >
+          ./transformer
+          "${GITHUB_WORKSPACE}/loki/docs/sources/get-started/quick-start.md"
+          "${GITHUB_WORKSPACE}/killercoda/loki/loki-quickstart"
+        working-directory: killercoda/tools/transformer
+      - run: ./scripts/manage-pr.bash
+        env:
+          GH_TOKEN: ${{ github.token }}
+        shell: bash
+        working-directory: killercoda

loki/loki-quickstart/index.json

@@ -1,24 +1,23 @@
 {
-    "title": "Loki Quickstart Demo",
-    "description": "This sandbox provides an online enviroment for testing the Loki quickstart demo.",
-    "details": {
-      "intro": {
-        "text": "intro.md"
+  "title": "Loki Quickstart Demo",
+  "description": "This sandbox provides an online enviroment for testing the Loki quickstart demo.",
+  "details": {
+    "intro": {
+      "text": "intro.md"
+    },
+    "steps": [
+      {
+        "text": "step1.md"
       },
-      "steps": [
-        {
-          "text": "step1.md"
-        },
-        {
-          "text": "step2.md"
-        }
-      ],
-      "finish": {
-        "text": "finished.md"
+      {
+        "text": "step2.md"
       }
+    ],
+    "finish": {
+      "text": "finished.md"
     }
-      ,
-    "backend": {
-      "imageid": "ubuntu"
-    }
-  }
+  },
+  "backend": {
+    "imageid": "ubuntu"
+  }
+}

loki/loki-quickstart/intro.md

@@ -1,19 +1,24 @@
-![Loki Quickstart](../../assets/loki-ile.png)
-
-
 # Quickstart to run Loki locally
 
- If you want to experiment with Loki, you can run Loki locally using the Docker Compose file that ships with Loki. It runs Loki in a [monolithic deployment](https://grafana.com/docs/loki/latest/get-started/deployment-modes/#monolithic-mode) mode and includes a sample application to generate logs.
+If you want to experiment with Loki, you can run Loki locally using the Docker Compose file that ships with Loki. It runs Loki in a [monolithic deployment](https://grafana.com/docs/loki/latest/get-started/deployment-modes/#monolithic-mode) mode and includes a sample application to generate logs.
 
 The Docker Compose configuration instantiates the following components, each in its own container:
 
-- **flog** a sample application which generates log lines.  [flog](https://github.com/mingrammer/flog) is a log generator for common log formats.
+- **flog** a sample application which generates log lines.
+  [flog](https://github.com/mingrammer/flog) is a log generator for common log formats.
+
 - **Grafana Alloy** which scrapes the log lines from flog, and pushes them to Loki through the gateway.
-- **Gateway** (NGINX) which receives requests and redirects them to the appropriate container based on the request's URL.
+
+- **Gateway** (nginx) which receives requests and redirects them to the appropriate container based on the request’s URL.
+
 - One Loki **read** component (Query Frontend, Querier).
+
 - One Loki **write** component (Distributor, Ingester).
+
 - One Loki **backend** component (Index Gateway, Compactor, Ruler, Bloom Compactor (Experimental), Bloom Gateway (Experimental)).
+
 - **Minio** an S3-compatible object store which Loki uses to store its index and chunks.
+
 - **Grafana** which provides visualization of the log lines captured within Loki.
 
-![Loki Quickstart](https://grafana.com/media/docs/loki/get-started-flog-v3.png)
+![Getting started sample application](https://grafana.com/media/docs/loki/get-started-flog-v3.png)

loki/loki-quickstart/step1.md

@@ -1,49 +1,54 @@
-
-# Step 1: Installing Loki and collecting sample logs
+# Install Loki and collecting sample logs
 
 **To install Loki locally, follow these steps:**
 
-1. Create a directory called `evaluate-loki` for the demo environment. Make `evaluate-loki` your current working directory:
+1. Create a directory called `evaluate-loki`{{copy}} for the demo environment.
+   Make `evaluate-loki`{{copy}} your current working directory:
+
+   ```bash
+   mkdir evaluate-loki
+   cd evaluate-loki
+   ```{{exec}}
+
+1. Download `loki-config.yaml`{{copy}}, `alloy-local-config.yaml`{{copy}}, and `docker-compose.yaml`{{copy}}:
+
+   ```bash
+   wget https://raw.githubusercontent.com/grafana/loki/main/examples/getting-started/loki-config.yaml -O loki-config.yaml
+   wget https://raw.githubusercontent.com/grafana/loki/main/examples/getting-started/alloy-local-config.yaml -O alloy-local-config.yaml
+   wget https://raw.githubusercontent.com/grafana/loki/main/examples/getting-started/docker-compose.yaml -O docker-compose.yaml
+   ```{{exec}}
+
+1. Deploy the sample Docker image.
 
-    ```bash
-    mkdir evaluate-loki
-    cd evaluate-loki
-    ```{{execute}}
+   With `evaluate-loki`{{copy}} as the current working directory, start the demo environment using `docker compose`{{copy}}:
 
-2. Download `loki-config.yaml`, `alloy-local-config.yaml`, and `docker-compose.yaml`:
+   ```bash
+   docker-compose up -d
+   ```{{exec}}
 
-    ```bash
-    wget https://raw.githubusercontent.com/grafana/loki/main/examples/getting-started/loki-config.yaml -O loki-config.yaml
-    wget https://raw.githubusercontent.com/grafana/loki/main/examples/getting-started/alloy-local-config.yaml -O alloy-local-config.yaml
-    wget https://raw.githubusercontent.com/grafana/loki/main/examples/getting-started/docker-compose.yaml -O docker-compose.yaml
-    ```{{execute}}
 
-3. Deploy the sample Docker image.
+   At the end of the command, you should see something similar to the following:
 
-    With `evaluate-loki` as the current working directory, start the demo environment using `docker compose`:
+   ```console
+   Creating evaluate-loki_flog_1  ... done
+   Creating evaluate-loki_minio_1 ... done
+   Creating evaluate-loki_read_1  ... done
+   Creating evaluate-loki_write_1 ... done
+   Creating evaluate-loki_gateway_1 ... done
+   Creating evaluate-loki_alloy_1   ... done
+   Creating evaluate-loki_grafana_1 ... done
+   Creating evaluate-loki_backend_1 ... done
+   ```
 
-    ```bash
-    docker-compose up -d
-    ```{{execute}}
 
-    You should see something similar to the following:
+1. (Optional) Verify that the Loki cluster is up and running.
 
-    ```bash
-    ✔ Network evaluate-loki_loki          Created      0.1s 
-    ✔ Container evaluate-loki-minio-1     Started      0.6s 
-    ✔ Container evaluate-loki-flog-1      Started      0.6s 
-    ✔ Container evaluate-loki-backend-1   Started      0.8s 
-    ✔ Container evaluate-loki-write-1     Started      0.8s 
-    ✔ Container evaluate-loki-read-1      Started      0.8s 
-    ✔ Container evaluate-loki-gateway-1   Started      1.1s 
-    ✔ Container evaluate-loki-grafana-1   Started      1.4s 
-    ✔ Container evaluate-loki-alloy-1     Started      1.4s
-    ```
+   - The read component returns `ready`{{copy}} when you browse to [http://localhost:3101/ready]({{TRAFFIC_HOST1_3101}}/ready).
+     The message `Query Frontend not ready: not ready: number of schedulers this worker is connected to is 0`{{copy}} shows until the read component is ready.
 
-4. (Optional) Verify that the Loki cluster is up and running.
-    - The read component returns `ready` when you point a web browser at [http://localhost:3101/ready]({{TRAFFIC_HOST1_3101}}/ready). The message `Query Frontend not ready: not ready: number of schedulers this worker is connected to is 0` will show prior to the read component being ready.
-    - The write component returns `ready` when you point a web browser at [http://localhost:3102/ready]({{TRAFFIC_HOST1_3102}}/ready). The message `Ingester not ready: waiting for 15s after being ready` will show prior to the write component being ready.
+   - The write component returns `ready`{{copy}} when you browse to [http://localhost:3102/ready]({{TRAFFIC_HOST1_3102}}/ready).
+     The message `Ingester not ready: waiting for 15s after being ready`{{copy}} shows until the write component is ready.
 
-5. (Optional) Verify that Grafana Alloy is running.
-    - Grafana Alloy's UI can be accessed at [http://localhost:12345]({{TRAFFIC_HOST1_12345}}).  
+1. (Optional) Verify that Grafana Alloy is running.
 
+   - You can access the Grafana Alloy UI at [http://localhost:12345]({{TRAFFIC_HOST1_12345}}).