Plugins 〉Guided Tour

Panel
grafana

Guided Tour

  • Overview
  • Installation
  • Change log
  • Related content

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

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

For more information, visit the docs on plugin installation.

Changelog

0.2.0 (2021-10-07)

  • BREAKING: Plugin ID renamed from yesoreyeram-guidedtour-panel to grafana-guidedtour-panel
  • BREAKING: Grafana dependency updated to >=8.1.0

0.1.0 (2021-07-12)

  • Signed version of the plugin released

0.0.4 (2021-07-02)

  • Feature: Support for customizing floater width
  • Bug fix: Fix missing colors

0.0.3 (2021-07-02)

  • Feature: Support for re-ordering steps
  • Experimental: Background image support for tour popups

0.0.2 (2021-07-02)

  • Feature: Support for customizing controller UI and content
  • Feature: Support for scrollOffset added
  • Feature: Support for customizing tour control
  • Feature: Support for customizing beacon position
  • Bug fix: Fixed a bug where finish cause redirection when closed the tour

0.0.1 (2021-07-01)

Initial release.