https://github.com/grafana/grafana-guidedtour-panel

Create guided tour on Grafana Dashboards
https://github.com/grafana/grafana-guidedtour-panel

grafana grafana-guided-tour grafana-panel grafana-plugin grafana-plugins

Last synced: 4 months ago
JSON representation

Create guided tour on Grafana Dashboards

• Host: GitHub
• URL: https://github.com/grafana/grafana-guidedtour-panel
• Owner: grafana
• License: apache-2.0
• Created: 2021-06-30T12:47:04.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-11T19:00:36.000Z (over 1 year ago)
• Last Synced: 2024-09-28T15:05:01.090Z (4 months ago)
• Topics: grafana, grafana-guided-tour, grafana-panel, grafana-plugin, grafana-plugins
• Language: TypeScript
• Homepage: https://grafana.com/grafana/plugins/grafana-guidedtour-panel/
• Size: 791 KB
• Stars: 7
• Watchers: 133
• Forks: 3
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Guided tour panel for grafana dashboards

Add guided tour to your Grafana dashboards.

**Disclaimer**: This plugin is an **EXPERIMENTAL** plugin. Only tested against selected versions of grafana and specific use cases.

![Guided tour panel cover image](https://user-images.githubusercontent.com/153843/124014480-7b062e80-d9db-11eb-8080-dd884f0ff5e8.png)

## Features

- Add guided steps targeting dashboard panels

- Customize the tour controller with custom markdown

- Customize tour color theme and style

- Support for grafana dark and light mode

- Does support markdown content

- Option to auto start the tour on dashboard load

- Option to redirect to different dashboard at the end of the tour

## Setup

1. Add Guided Tour Panel to your dashboard like any other panel.

2. Add as many steps required. Provide exact panel title for the step and then specify content. Content can be in markdown format.

3. Customize the look and feel if required.

## Known limitations

- Panels you are navigating should be in viewport

- Panels collapsed inside dashboard rows can't be targeted

- Guided tour panel controller needs to be at the top of the dashboard or at least it should be in viewport