https://github.com/grafana/killercoda
This repository holds tutorials designed and hosted on Killercoda and interactive education platform.
https://github.com/grafana/killercoda
demo education keep lgtm tutorial
Last synced: 3 months ago
JSON representation
This repository holds tutorials designed and hosted on Killercoda and interactive education platform.
- Host: GitHub
- URL: https://github.com/grafana/killercoda
- Owner: grafana
- License: apache-2.0
- Created: 2024-03-07T14:28:54.000Z (about 1 year ago)
- Default Branch: staging
- Last Pushed: 2025-01-29T11:00:51.000Z (3 months ago)
- Last Synced: 2025-01-29T11:51:14.357Z (3 months ago)
- Topics: demo, education, keep, lgtm, tutorial
- Language: Go
- Homepage: https://killercoda.com/grafana-labs
- Size: 3.35 MB
- Stars: 15
- Watchers: 5
- Forks: 9
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Killercoda - Grafana Labs Tutorials
Welcome to the Grafana Labs tutorials repository.
This repository contains interactive tutorials for Grafana Labs, hosted on [Killercoda](https://killercoda.com/grafana-labs/).
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](./docs/transformer.md)
You can also find fully annotated doc examples of tutorials in the [examples](./docs/examples) directory.
## Run a tutorial
To run a Grafana Labs Killercoda tutorial:
1. Browse to the [Grafana Labs section](https://killercoda.com/grafana-labs) on Killercoda.
1. Select the tutorial you want to complete.
1. 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](https://raintank-corp.slack.com/archives/C0318UGJB98).
- 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](./docs/transformer.md#generate-a-tutorial) 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](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo).
1. Clone your fork.
For more information, refer to [Cloning your forked repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo#cloning-your-forked-repository)
1. 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](https://grafana.com/docs/writers-toolkit/write/tooling-and-workflows/#create-a-branch-from-the-default-remote-branch).
1. Make your changes and commit them.
For more information on staging files, refer to [Commit changes to your branch](https://grafana.com/docs/writers-toolkit/write/tooling-and-workflows/#commit-changes-to-your-branch).
1. Push your changes to your forked repository on GitHub.
1. 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](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/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.