Documentation Plugins Interactive learning Administrators reference

Administrators reference

This section covers the administrator features of the Interactive learning plugin. These features allow Grafana administrators to tailor the Interactive learning plugin to the needs of Grafana users.

Accessing the configuration page

You can access the configuration page in two ways:

1. Click the settings gear icon in the top right corner of the expanded Interactive learning sidebar.
2. Navigate to Administration > Plugins and data > Plugins, search for “Interactive learning”.

Configuration options

The plugin page contains several tabs that control different aspects of the Interactive learning plugin.

Recommendations

The recommender service provides personalized documentation recommendations based on your current context in Grafana. When disabled, Interactive learning only displays bundled examples and static recommendations.

To enable the recommender service:

1. Review the data usage information to understand what data is collected and how it’s used.
2. Toggle Enable context-aware recommendations to enable the service.
3. Click Save settings.

When you enable the recommender service, Interactive learning sends contextual data to Grafana’s hosted recommendation service. The service uses this data to provide personalized documentation recommendations. For more information about data collection and privacy, refer to the data usage details in the configuration page and the Architecture documentation.

Auto-launch tutorial URL

You can configure a tutorial or documentation page to automatically open when users open the Interactive learning sidebar. This feature is useful for demo scenarios or onboarding new users.

To configure auto-launch:

1. Navigate to the Plugin Configuration section.
2. Enter the full URL of a learning journey or documentation page in the Auto-launch tutorial URL field.
3. Click Save configuration.

Example URL:

• https://grafana.com/tutorials/grafana-fundamentals/

Global link interception (Experimental)

Global link interception allows Interactive learning to intercept documentation links anywhere in Grafana and open them in the sidebar instead of a new tab.

To enable global link interception:

1. Navigate to the Global Link Interception section in the configuration page.
2. Toggle Intercept documentation links globally to enable the feature.
3. Click Save configuration.

When enabled, clicking documentation links anywhere in Grafana automatically opens the sidebar and displays the documentation inside. If the sidebar hasn’t fully loaded, links are queued and opened when ready.

Keyboard modifiers:

You can override link interception using keyboard modifiers:

• Hold Ctrl (Windows/Linux) or Cmd (Mac) while clicking to open links in a new tab instead.
• Middle-click also opens links in a new tab.

Open panel on launch

You can configure Interactive learning to automatically open when users first load Grafana.

To enable auto-open:

1. Navigate to the Open Panel on Launch section in the configuration page.
2. Toggle Automatically open Interactive learning panel when Grafana loads to enable the feature.
3. Click Save configuration.

The sidebar opens when Grafana loads for the first time in a browser session. It won’t reopen on subsequent page navigations within Grafana. The panel resets to auto-open behavior when you refresh the page or start a new browser session.

Interactive tutorial features

Interactive tutorials include auto-completion detection and timing parameters that control how tutorials behave.

Auto-completion detection (Experimental)

Auto-completion detection automatically marks tutorial steps as complete when users perform actions themselves without clicking Do it buttons.

To enable auto-completion:

1. Navigate to the Interactive Tutorial Features section in the configuration page.
2. Toggle Enable automatic step completion to enable the feature.
3. Click Save configuration.

When enabled, the system detects user actions and completes tutorial steps automatically for a more natural learning experience. Steps still verify requirements before completion.

When disabled, users must click Do it buttons to complete tutorial steps.

Advanced settings

You can fine-tune timing parameters for interactive tutorial behavior.

Requirements check timeout:

Maximum time to wait for requirement validation.

• Range: 1000-10000ms
• Default: 3000ms

Guided step timeout:

Maximum time to wait for users to complete guided steps.

• Range: 5000-120000ms (5s-2min)
• Default: 30000ms

To modify these settings:

1. Navigate to the Advanced Settings section under Interactive Tutorial Features.
2. Enter new values for the timeout fields.
3. Click Save configuration to apply changes, or click Reset to defaults to restore default values.

Dev mode

Dev mode disables security protections and enables debugging features for development purposes.

Dev mode is only visible when you access the configuration page with ?dev=true in the URL or when it’s already enabled for your user.

Security protections disabled in dev mode:

• Bypasses branch validation for GitHub repositories.
• Allows loading content from any localhost URL.
• Exposes debug tools that can manipulate the Grafana DOM.
• Bypasses source validation for interactive content.

To enable dev mode:

1. Navigate to the configuration page with ?dev=true in the URL.
2. Review the security warnings.
3. Toggle Dev Mode to enable the feature.

The page reloads automatically to apply changes. Dev mode is stored per-user and requires admin permissions to change.

When dev mode is enabled, you can also configure the Recommender service URL to point to a local development instance.