Killercoda - Grafana Labs Tutorials

Welcome to the Grafana Labs tutorials repository. This repository contains interactive tutorials for Grafana Labs, hosted on Killercoda. These tutorials aim to help users understand and implement Grafana solutions without the need to download or install the software.

Some tutorials are generated from Grafana Labs documentation. If you want to modify a generated tutorial or prepare documentation for generation, refer to About the transformer tool

You can also find fully annotated doc examples of tutorials in the examples directory.

Run a tutorial

To run a Grafana Labs Killercoda tutorial:

1. Browse to the Grafana Labs section on Killercoda.

2. Select the tutorial you want to complete.

3. Follow the step-by-step instructions in the scenario.

   Each tutorial is fully interactive and runs directly in your browser.

Contribute to this repository

We welcome contributions to enhance these tutorials.

Before you begin

• Get access to the Grafana Labs Killercoda account.

  Note: You must be a Grafana Labs employee.

  To do this, reach out to the Developer Advocacy team on Slack.

• Become familiar with the Grafana topic you want to write a tutorial for.

Propose changes

Note: Use the following contribution steps if you want to create a tutorial that's not also part of Grafana Labs documentation. Otherwise follow these steps to generate a tutorial from that documentation.

1. Fork the repository by clicking on the Fork button on the top right corner of this page.

   For more information, refer to Fork a repository.

2. Clone your fork.

   For more information, refer to Cloning your forked repository

3. In your local repository, create a branch for your changes.

   Use a name that describes the nature of your changes, like update_tutorial_1.

   For more information, refer to Create a branch from the default remote branch.

4. Make your changes and commit them.

   For more information on staging files, refer to Commit changes to your branch.

5. Push your changes to your forked repository on GitHub.

6. In GitHub, create a pull request from your forked repository to this repository.

   • Provide a concise and informative title and description for your pull request.
   • Link any relevant issues.

   For more information refer to Creating a pull request.

Guidelines

• Ensure your changes are consistent with the existing tutorial format.
• Verify that your changes don't break any existing functionality.
• Include screenshots in your PR, if you're changing the UI or adding significant visual components.

Support

If you encounter any issues while going through the tutorials, open an issue in this repository.