Product tour by mnocon · Pull Request #3065 · ibexa/documentation-developer

mnocon · 2026-02-18T07:56:41Z

Target: 4.6, 5.0

Documentation for the Product Tour feature - an extension of Integrated Help.

TODO: screenshots are missing in indicated places

User doc PR: ibexa/documentation-user#390

Covers https://github.com/ibexa/integrated-help/pull/59 and https://github.com/ibexa/integrated-help/pull/58 as well

github-actions · 2026-02-18T07:56:53Z

Preview of modified files

Preview of modified Markdown:

mnocon · 2026-02-18T07:57:30Z

code_samples/back_office/product_tour/config/general_scenario.yaml

+                                    alt_translation_key: tour.image.alt
+                              - type: video
+                                params:
+                                    #  'Big Buck Bunny' licensed under CC 3.0 by the Blender foundation. Hosted by archive.org


Idea stolen from https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/video#single_source

mnocon · 2026-02-18T07:58:08Z

composer.json

        "ibexa/share": "~4.6.x-dev",
-        "ibexa/phpstan": "~4.6.-dev"
+        "ibexa/phpstan": "~4.6.-dev",
+        "ibexa/integrated-help": "dev-dev as 4.6.x-dev"


TMP branch to make PHPStan happy

mnocon · 2026-02-18T07:58:50Z

docs/api/event_reference/integrated_help_events.md

+With the following example, the scenario is modified to trigger only when certain conditions are matched. When the current user has a pending [notification]([[= user_doc =]]/getting_started/notifications/), a custom onboarding scenario is triggered.
+
+First, define a custom product tour scenario.
+It contains a placeholder step with a single block.


A scenario MUST have at least one step, with at least one block - that's why I need to add a placeholder step in Yaml and remove all of them in PHP code

docs/administration/back_office/configure_product_tour.md

+
+    Clickable and draggable modes are designed for single actions only (buttons, links).
+    You can't select an entire form.
+    If the interaction with the highlighted element results in redirection to a new page or opening a modal window where the previous target element can't be found, the "Previous" navigation step will be disabled.


wiewiurdp · 2026-02-20T12:07:59Z

docs/administration/back_office/configure_product_tour.md

+Embed images with alternative text:
+
+```yaml
+[[= include_file('code_samples/back_office/product_tour/config/general_scenario.yaml', 21, 25) =]]


wouldn't be better to give a example with asset added to public folder. Before block give example that 'I add a photo public/img/welcome.jpg and in config put img/welcome.jpg

docs/administration/back_office/customize_product_tour.md

+``` yaml
+ibexa:
+    system:
+        default:


code_samples/back_office/product_tour/config/general_scenario.yaml

@@ -0,0 +1,39 @@
+ibexa:
+    system:
+        default:


code_samples/back_office/product_tour/config/targetable_scenario.yaml

@@ -0,0 +1,39 @@
+ibexa:
+    system:
+        default:


docs/administration/back_office/configure_product_tour.md

+
+For **general scenario**, the scenario appears at the earliest opportunity (on any page after logging in), with an exception of the user settings area.
+
+For **targeted scenarios**, the scenario begins if the target element is found in the DOM.


albozek · 2026-02-20T13:35:25Z

docs/administration/back_office/product_tour.md

+The steps building the scenario support three interaction modes:
+
+- Standard - Users navigate between steps using "Previous" and "Next" buttons
+- Clickable - Users must click the highlighted element to proceed to the next step


Just an idea: we can mention, that if someone would want to go to prev step in clickable or draggable mode it is possible only by restarting tour (for example via user setting after finishing tour)

Added in f12bdcb

albozek · 2026-03-31T10:14:07Z

docs/administration/back_office/product_tour.md

+Users can complete a tour with one of the following actions:
+
+- by finishing all steps
+- by skipping it with the **Exit tour** button


This button differs depending on the tour type. Target tour has "Exit tour" button but general tour exit button has "Skip" label.

github-actions · 2026-03-31T12:43:23Z

code_samples/ change report

Before (on target branch)	After (in current PR)
`code_samples/back_office/product_tour/config/general_scenario.yaml`	`code_samples/back_office/product_tour/config/general_scenario.yaml`
	docs/administration/back_office/configure_product_tour.md@140:```yaml hl_lines="6 11" `docs/administration/back_office/configure_product_tour.md@141:[[= include_file('code_samples/back_office/product_tour/config/general_scenario.yaml', 0, 14) =]]` docs/administration/back_office/configure_product_tour.md@142:``` `001⫶ibexa:` `002⫶ system:` `003⫶ admin_group:` `004⫶ product_tour:` `005⫶ my_general_scenario:` `006❇️ type: 'general'` `007⫶ scenario_title_translation_key: tour.my_general_scenario.title` `008⫶ steps:` `009⫶ welcome_step:` `010⫶ step_title_translation_key: title` `011❇️ background_image: /public/img/background.jpg` `012⫶ blocks:` `013⫶ - type: title` `014⫶ params:` docs/administration/back_office/configure_product_tour.md@212:```yaml `docs/administration/back_office/configure_product_tour.md@213:[[= include_file('code_samples/back_office/product_tour/config/general_scenario.yaml', 12, 15) =]]` docs/administration/back_office/configure_product_tour.md@214:``` `001⫶ - type: title` `002⫶ params:` `003⫶ text_translation_key: subtitle` docs/administration/back_office/configure_product_tour.md@220:```yaml `docs/administration/back_office/configure_product_tour.md@221:[[= include_file('code_samples/back_office/product_tour/config/general_scenario.yaml', 15, 18) =]]` docs/administration/back_office/configure_product_tour.md@222:``` `001⫶ - type: text` `002⫶ params:` `003⫶ text_translation_key: tour.step.description` docs/administration/back_office/configure_product_tour.md@228:```yaml `docs/administration/back_office/configure_product_tour.md@229:[[= include_file('code_samples/back_office/product_tour/config/general_scenario.yaml', 18, 22) =]]` docs/administration/back_office/configure_product_tour.md@230:``` `001⫶ - type: link` `002⫶ params:` `003⫶ url: https://doc.ibexa.co` `004⫶ text_translation_key: tour.link.documentation` docs/administration/back_office/configure_product_tour.md@236:```yaml `docs/administration/back_office/configure_product_tour.md@237:[[= include_file('code_samples/back_office/product_tour/config/general_scenario.yaml', 30, 37) =]]` docs/administration/back_office/configure_product_tour.md@238:``` `001⫶ - type: list` `002⫶ params:` `003⫶ title_translation_key: tour.list.title` `004⫶ items_translation_keys:` `005⫶ - tour.list.item1` `006⫶ - tour.list.item2` `007⫶ - tour.list.item3` docs/administration/back_office/configure_product_tour.md@254:```yaml `docs/administration/back_office/configure_product_tour.md@255:[[= include_file('code_samples/back_office/product_tour/config/general_scenario.yaml', 22, 26) =]]` docs/administration/back_office/configure_product_tour.md@256:``` `001⫶ - type: image` `002⫶ params:` `003⫶ src: /public/img/diagram.jpg` `004⫶ alt_translation_key: tour.image.alt` docs/administration/back_office/configure_product_tour.md@262:```yaml `docs/administration/back_office/configure_product_tour.md@263:[[= include_file('code_samples/back_office/product_tour/config/general_scenario.yaml', 26, 30) =]]` docs/administration/back_office/configure_product_tour.md@264:``` `001⫶ - type: video` `002⫶ params:` `003⫶ # 'Big Buck Bunny' licensed under CC 3.0 by the Blender foundation. Hosted by archive.org` `004⫶ url: https://archive.org/download/BigBuckBunny_124/Content/big_buck_bunny_720p_surround.mp4` docs/administration/back_office/configure_product_tour.md@270:```yaml `docs/administration/back_office/configure_product_tour.md@271:[[= include_file('code_samples/back_office/product_tour/config/general_scenario.yaml', 37, 40) =]]` docs/administration/back_office/configure_product_tour.md@272:``` `001⫶ - type: twig_template` `002⫶ params:` `003⫶ template: custom_template.html.twig` docs/administration/back_office/configure_product_tour.md@294:```yaml `docs/administration/back_office/configure_product_tour.md@295:[[= include_file('code_samples/back_office/product_tour/config/general_scenario.yaml') =]]` docs/administration/back_office/configure_product_tour.md@296:``` `001⫶ibexa:` `002⫶ system:` `003⫶ admin_group:` `004⫶ product_tour:` `005⫶ my_general_scenario:` `006⫶ type: 'general'` `007⫶ scenario_title_translation_key: tour.my_general_scenario.title` `008⫶ steps:` `009⫶ welcome_step:` `010⫶ step_title_translation_key: title` `011⫶ background_image: /public/img/background.jpg` `012⫶ blocks:` `013⫶ - type: title` `014⫶ params:` `015⫶ text_translation_key: subtitle` `016⫶ - type: text` `017⫶ params:` `018⫶ text_translation_key: tour.step.description` `019⫶ - type: link` `020⫶ params:` `021⫶ url: https://doc.ibexa.co` `022⫶ text_translation_key: tour.link.documentation` `023⫶ - type: image` `024⫶ params:` `025⫶ src: /public/img/diagram.jpg` `026⫶ alt_translation_key: tour.image.alt` `027⫶ - type: video` `028⫶ params:` `029⫶ # 'Big Buck Bunny' licensed under CC 3.0 by the Blender foundation. Hosted by archive.org` `030⫶ url: https://archive.org/download/BigBuckBunny_124/Content/big_buck_bunny_720p_surround.mp4` `031⫶ - type: list` `032⫶ params:` `033⫶ title_translation_key: tour.list.title` `034⫶ items_translation_keys:` `035⫶ - tour.list.item1` `036⫶ - tour.list.item2` `037⫶ - tour.list.item3` `038⫶ - type: twig_template` `039⫶ params:` `040⫶ template: custom_template.html.twig`
`code_samples/back_office/product_tour/config/targetable_scenario.yaml`	`code_samples/back_office/product_tour/config/targetable_scenario.yaml`
	docs/administration/back_office/configure_product_tour.md@149:```yaml hl_lines="6 11" `docs/administration/back_office/configure_product_tour.md@150:[[= include_file('code_samples/back_office/product_tour/config/targetable_scenario.yaml', 0, 15) =]]` docs/administration/back_office/configure_product_tour.md@151:``` `001⫶ibexa:` `002⫶ system:` `003⫶ admin_group:` `004⫶ product_tour:` `005⫶ targetable_dashboard_scenario:` `006❇️ type: 'targetable'` `007⫶ scenario_title_translation_key: tour.targetable_dashboard_scenario.title` `008⫶ steps:` `009⫶ dashboard_options:` `010⫶ step_title_translation_key: Open Dashboard options` `011❇️ target: ".ibexa-db-header__more"` `012⫶ # No interaction_mode specified or the value is set to null` `013⫶ blocks:` `014⫶ - type: text` `015⫶ params:` docs/administration/back_office/configure_product_tour.md@176:```yaml `docs/administration/back_office/configure_product_tour.md@177:[[= include_file('code_samples/back_office/product_tour/config/targetable_scenario.yaml', 8, 16) =]]` docs/administration/back_office/configure_product_tour.md@178:``` `001⫶ dashboard_options:` `002⫶ step_title_translation_key: Open Dashboard options` `003⫶ target: ".ibexa-db-header__more"` `004⫶ # No interaction_mode specified or the value is set to null` `005⫶ blocks:` `006⫶ - type: text` `007⫶ params:` `008⫶ text_translation_key: Learn how to customize the blocks displayed on your dashboard` docs/administration/back_office/configure_product_tour.md@185:```yaml `docs/administration/back_office/configure_product_tour.md@186:[[= include_file('code_samples/back_office/product_tour/config/targetable_scenario.yaml', 16, 24) =]]` docs/administration/back_office/configure_product_tour.md@187:``` `001⫶ open_dashboard_options:` `002⫶ step_title_translation_key: Open Dashboard options` `003⫶ target: '.ibexa-db-header__more'` `004⫶ interaction_mode: clickable` `005⫶ blocks:` `006⫶ - type: text` `007⫶ params:` `008⫶ text_translation_key: Click here to customize your dashboard` docs/administration/back_office/configure_product_tour.md@194:```yaml `docs/administration/back_office/configure_product_tour.md@195:[[= include_file('code_samples/back_office/product_tour/config/targetable_scenario.yaml', 32, 40) =]]` docs/administration/back_office/configure_product_tour.md@196:``` `001⫶ drag_and_drop_step:` `002⫶ step_title_translation_key: Drag-and-drop blocks` `003⫶ target: ".c-pb-toolbox-blocks-group__blocks > * .c-pb-toolbox-block__content:first-of-type"` `004⫶ interaction_mode: draggable` `005⫶ blocks:` `006⫶ - type: text` `007⫶ params:` `008⫶ text_translation_key: Drag-and-drop blocks from the sidebar to the dashboard to customize it` docs/administration/back_office/configure_product_tour.md@302:```yaml `docs/administration/back_office/configure_product_tour.md@303:[[= include_file('code_samples/back_office/product_tour/config/targetable_scenario.yaml') =]]` docs/administration/back_office/configure_product_tour.md@304:``` `001⫶ibexa:` `002⫶ system:` `003⫶ admin_group:` `004⫶ product_tour:` `005⫶ targetable_dashboard_scenario:` `006⫶ type: 'targetable'` `007⫶ scenario_title_translation_key: tour.targetable_dashboard_scenario.title` `008⫶ steps:` `009⫶ dashboard_options:` `010⫶ step_title_translation_key: Open Dashboard options` `011⫶ target: ".ibexa-db-header__more"` `012⫶ # No interaction_mode specified or the value is set to null` `013⫶ blocks:` `014⫶ - type: text` `015⫶ params:` `016⫶ text_translation_key: Learn how to customize the blocks displayed on your dashboard` `017⫶ open_dashboard_options:` `018⫶ step_title_translation_key: Open Dashboard options` `019⫶ target: '.ibexa-db-header__more'` `020⫶ interaction_mode: clickable` `021⫶ blocks:` `022⫶ - type: text` `023⫶ params:` `024⫶ text_translation_key: Click here to customize your dashboard` `025⫶ customize_dashboard:` `026⫶ step_title_translation_key: Customize Dashboard` `027⫶ target: '.ibexa-db-actions-popup-menu'` `028⫶ interaction_mode: clickable` `029⫶ blocks:` `030⫶ - type: text` `031⫶ params:` `032⫶ text_translation_key: Choose "Customize dashboard"` `033⫶ drag_and_drop_step:` `034⫶ step_title_translation_key: Drag-and-drop blocks` `035⫶ target: ".c-pb-toolbox-blocks-group__blocks > * .c-pb-toolbox-block__content:first-of-type"` `036⫶ interaction_mode: draggable` `037⫶ blocks:` `038⫶ - type: text` `039⫶ params:` `040⫶ text_translation_key: Drag-and-drop blocks from the sidebar to the dashboard to customize it`
`code_samples/back_office/product_tour/src/EventSubscriber/NotificationScenarioSubscriber.php`	`code_samples/back_office/product_tour/src/EventSubscriber/NotificationScenarioSubscriber.php`
	docs/administration/back_office/customize_product_tour.md@42:```php hl_lines="35-37 39-41 43-45 47-58" `docs/administration/back_office/customize_product_tour.md@43:[[= include_file('code_samples/back_office/product_tour/src/EventSubscriber/NotificationScenarioSubscriber.php') =]]` docs/administration/back_office/customize_product_tour.md@44:``` `001⫶<?php` `002⫶` `003⫶declare(strict_types=1);` `004⫶` `005⫶namespace App\EventSubscriber;` `006⫶` `007⫶use Ibexa\Contracts\Core\Repository\NotificationService;` `008⫶use Ibexa\Contracts\IntegratedHelp\Event\RenderProductTourScenarioEvent;` `009⫶use Ibexa\IntegratedHelp\ProductTour\Block\LinkBlock;` `010⫶use Ibexa\IntegratedHelp\ProductTour\Block\TextBlock;` `011⫶use Ibexa\IntegratedHelp\ProductTour\ProductTourStep;` `012⫶use Symfony\Component\EventDispatcher\EventSubscriberInterface;` `013⫶` `014⫶final class NotificationScenarioSubscriber implements EventSubscriberInterface` `015⫶{` `016⫶ private NotificationService $notificationService;` `017⫶` `018⫶ public function __construct(NotificationService $notificationService)` `019⫶ {` `020⫶ $this->notificationService = $notificationService;` `021⫶ }` `022⫶` `023⫶ public static function getSubscribedEvents(): array` `024⫶ {` `025⫶ return [` `026⫶ RenderProductTourScenarioEvent::class => ['onRenderScenario'],` `027⫶ ];` `028⫶ }` `029⫶` `030⫶ public function onRenderScenario(RenderProductTourScenarioEvent $event): void` `031⫶ {` `032⫶ $scenario = $event->getScenario();` `033⫶ $steps = $scenario->getSteps();` `034⫶` `035❇️ if ($scenario->getIdentifier() !== 'notifications') {` `036❇️ return;` `037❇️ }` `038⫶` `039❇️ foreach ($steps as $step) {` `040❇️ $scenario->removeStep($step);` `041❇️ }` `042⫶` `043❇️ if (!$this->hasUnreadNotifications()) {` `044❇️ return;` `045❇️ }` `046⫶` `047❇️ $customStep = new ProductTourStep();` `048❇️ $customStep->setIdentifier('custom_step_identifier');` `049❇️ $customStep->setInteractionMode('clickable');` `050❇️ $customStep->setTarget('.ibexa-header-user-menu__notifications-toggler');` `051❇️ $customStep->setTitle('You have unread notifications');` `052❇️ $customStep->addBlock(new TextBlock('Click here to preview your unread notifications.'));` `053❇️ $customStep->addBlock(new LinkBlock(` `054❇️ 'https://doc.ibexa.co/projects/userguide/en/latest/getting_started/notifications/',` `055❇️ 'Learn more about notifications'` `056❇️ ));` `057❇️` `058❇️ $scenario->addStep($customStep);` `059⫶ }` `060⫶` `061⫶ private function hasUnreadNotifications(): bool` `062⫶ {` `063⫶ return $this->notificationService->getPendingNotificationCount() > 0;` `064⫶ }` `065⫶}`

Download colorized diff

sonarqubecloud · 2026-03-31T12:48:48Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

dabrt · 2026-03-31T11:42:12Z

docs/administration/back_office/customize_integrated_help.md


-After you have installed the integrated help package, you may still want to disable it globally, for example, to run UI tests in a `dev` [environment](environments.md).
-To do it, in `config/packages` create the `ibexa_integrated_help.yaml` file, with the following configuration:
+After you have installed the integrated help package, you can disable the entire feature or specific features on the system level.


Suggested change

After you have installed the integrated help package, you can disable the entire feature or specific features on the system level.

After you have installed the integrated help package, you can disable the entire package or specific features on the system level.

Alternatively, use "feature" for the overall set pprovided by the [ackage, and functionalities for the patrs. This would require updating line 18, 22, 31 and other occurrences by replacing "features" with "functionalities":

Suggested change

After you have installed the integrated help package, you can disable the entire feature or specific features on the system level.

After you have installed the integrated help package, you can disable the entire feature or specific functionalities on the system level.

dabrt · 2026-03-31T11:52:48Z

docs/administration/back_office/customize_integrated_help.md

+
+### Disable all features
+
+To disable both the Help center and the Product tour globally, for example, to run UI tests in a `dev` [environment](environments.md), in `config/packages` create the `ibexa_integrated_help.yaml` file with the following configuration:


Suggested change

To disable both the Help center and the Product tour globally, for example, to run UI tests in a `dev` [environment](environments.md), in `config/packages` create the `ibexa_integrated_help.yaml` file with the following configuration:

To disable both the Help center and the Product tour globally, for example, to run UI tests in a `dev` [environment](environments.md), in `config/packages`, create the `ibexa_integrated_help.yaml` file with the following configuration:

dabrt · 2026-03-31T12:03:32Z

docs/administration/back_office/configure_product_tour.md

+
+## Configuration structure
+
+Configure product tour scenarios under the `ibexa.system.<siteaccess>.product_tour` key.


Suggested change

Configure product tour scenarios under the `ibexa.system.<siteaccess>.product_tour` key.

You configure product tour scenarios under the `ibexa.system.<siteaccess>.product_tour` key.

"Configure ... " is a direct order. "You configure ..." is a statement of fact

dabrt · 2026-03-31T12:04:10Z

docs/administration/back_office/configure_product_tour.md

+Configure product tour scenarios under the `ibexa.system.<siteaccess>.product_tour` key.
+Each scenario has a unique identifier and contains steps, which in turn contain blocks.
+
+Basic configuration structure of a scenario:


Suggested change

Basic configuration structure of a scenario:

The basic configuration structure of a scenario is as follows:

dabrt · 2026-03-31T12:07:16Z

docs/administration/back_office/configure_product_tour.md

+```
+
+The product tour scenarios are meant to be translatable.
+It's recommended to use translation keys instead of literal values in the YAML configuration, and provide the translations separately.


How about "Ibexa recommends..."? I don't like "we recommend", which prevails in our doc, but would suggest trying to eliminate passive voice

dabrt · 2026-04-01T07:08:29Z

docs/administration/back_office/product_tour.md

+- **Scenario** - A complete onboarding scenario containing multiple steps that guide users through a specific feature or workflow
+- **Step** - An individual instruction or explanation within a scenario, containing blocks, displayed as an overlay or tooltip
+- **Block** - A content element within a step, such as text, images, videos, or links that provide information to the user


Suggested change

- **Scenario** - A complete onboarding scenario containing multiple steps that guide users through a specific feature or workflow

- **Step** - An individual instruction or explanation within a scenario, containing blocks, displayed as an overlay or tooltip

- **Block** - A content element within a step, such as text, images, videos, or links that provide information to the user

- **Scenario** - a complete onboarding scenario containing multiple steps that guide users through a specific feature or workflow

- **Step** - an individual instruction or explanation within a scenario, containing blocks, displayed as an overlay or tooltip

- **Block** - a content element within a step, such as text, images, videos, or links that provide information to the user

dabrt · 2026-04-01T07:10:29Z

docs/administration/back_office/product_tour.md

+### General scenarios
+
+General tours display information in centered modals without targeting specific UI elements.
+These tours provide an overview of features or concepts without requiring interaction with particular interface elements.


Suggested change

These tours provide an overview of features or concepts without requiring interaction with particular interface elements.

These tours provide an overview of features or concepts and do not require interaction with particular interface elements.

To avoid repeating similar sentence structure in immediate vicinity.

dabrt · 2026-04-01T07:12:07Z

docs/administration/back_office/product_tour.md

+### Targeted scenarios
+
+Targeted scenarios highlight specific UI elements on the page and guide users through interactive workflows.
+Each step targets a particular element using CSS selectors, drawing attention to buttons, navigation elements, or other interface components.


Suggested change

Each step targets a particular element using CSS selectors, drawing attention to buttons, navigation elements, or other interface components.

Each step targets a particular element by using a CSS selector, and can draw attention to buttons, navigation elements, or other interface components.

dabrt · 2026-04-01T07:13:07Z

docs/administration/back_office/product_tour.md

+
+The steps building the scenario support three interaction modes:
+
+- **Standard** - Users navigate between steps using "Previous" and "Next" buttons


Suggested change

- **Standard** - Users navigate between steps using "Previous" and "Next" buttons

- **Standard** - Users navigate between steps by clicking **Previous** and **Next** buttons

dabrt · 2026-04-01T07:16:03Z

docs/administration/back_office/product_tour.md

+
+At any time, users can manually restart completed tours from their [user settings]([[= user_doc =]]/getting_started/get_started/#user-settings).
+
+To start building your custom onboarding scenarios, see [configure product tour](configure_product_tour.md).


Suggested change

To start building your custom onboarding scenarios, see [configure product tour](configure_product_tour.md).

To start building your custom onboarding scenarios, see [Configure product tour](configure_product_tour.md).

adriendupuis · 2026-04-02T10:12:53Z

docs/administration/back_office/product_tour.md

+
+# Product tour
+
+Product tour is an in-app onboarding tool that helps users discover and learn [[= product_name =]] features through interactive, step-by-step guided walkthroughs.


I would remind that this is for BO users:

Suggested change

Product tour is an in-app onboarding tool that helps users discover and learn [[= product_name =]] features through interactive, step-by-step guided walkthroughs.

Product tour is an in-app onboarding tool that helps back office contributors discover [[= product_name =]] features through interactive, step-by-step guided walkthroughs.

Product tour doc skeleton

e5e94f2

mnocon commented Feb 18, 2026

View reviewed changes

mnocon marked this pull request as ready for review February 18, 2026 08:05

mnocon mentioned this pull request Feb 20, 2026

Product tour ibexa/documentation-user#390

Open

Review feedback

0b4a2f7

mnocon force-pushed the product-tour branch from f3949db to 0b4a2f7 Compare February 20, 2026 08:38

Vale

2498bb9

wiewiurdp reviewed Feb 20, 2026

View reviewed changes

albozek reviewed Feb 20, 2026

View reviewed changes

Review feedback - part 2

1ba34c7

mnocon force-pushed the product-tour branch from 2db00b2 to 1ba34c7 Compare February 23, 2026 08:18

mnocon added 2 commits March 30, 2026 15:25

Added doc for the new config

be4a158

Merge remote-tracking branch 'origin/4.6' into product-tour

7bd3cbf

ibexa deleted a comment from github-actions bot Mar 30, 2026

ibexa deleted a comment from sonarqubecloud bot Mar 30, 2026

Review feedback

f12bdcb

mnocon added the Needs DEV review label Mar 30, 2026

mnocon requested review from albozek and wiewiurdp March 30, 2026 13:42

mnocon added 2 commits March 30, 2026 15:53

Adjusted includes

ac613fd

Wording

732b6cc

albozek approved these changes Mar 31, 2026

View reviewed changes

wiewiurdp approved these changes Mar 31, 2026

View reviewed changes

mnocon added Needs DOC review and removed Needs DEV review labels Mar 31, 2026

mnocon requested a review from a team March 31, 2026 10:19

ibexa-workflow-automation-1 bot requested review from adriendupuis, dabrt and julitafalcondusza and removed request for a team March 31, 2026 10:19

Specified button name

a3e33a9

dabrt requested changes Apr 1, 2026

View reviewed changes

adriendupuis added the Wait with merge PRs that shouldn't be merged instantly label Apr 2, 2026

adriendupuis reviewed Apr 2, 2026

View reviewed changes

adriendupuis mentioned this pull request Apr 2, 2026

Release notes #3076

Draft

7 tasks


		For general scenario, the scenario appears at the earliest opportunity (on any page after logging in), with an exception of the user settings area.

		For targeted scenarios, the scenario begins if the target element is found in the DOM.

	After you have installed the integrated help package, you can disable the entire feature or specific features on the system level.
	After you have installed the integrated help package, you can disable the entire package or specific features on the system level.


		### Disable all features

		To disable both the Help center and the Product tour globally, for example, to run UI tests in a `dev` [environment](environments.md), in `config/packages` create the `ibexa_integrated_help.yaml` file with the following configuration:


		## Configuration structure

		Configure product tour scenarios under the `ibexa.system.<siteaccess>.product_tour` key.

	Configure product tour scenarios under the `ibexa.system.<siteaccess>.product_tour` key.
	You configure product tour scenarios under the `ibexa.system.<siteaccess>.product_tour` key.

	Basic configuration structure of a scenario:
	The basic configuration structure of a scenario is as follows:

	These tours provide an overview of features or concepts without requiring interaction with particular interface elements.
	These tours provide an overview of features or concepts and do not require interaction with particular interface elements.

	Each step targets a particular element using CSS selectors, drawing attention to buttons, navigation elements, or other interface components.
	Each step targets a particular element by using a CSS selector, and can draw attention to buttons, navigation elements, or other interface components.


		The steps building the scenario support three interaction modes:

		- Standard - Users navigate between steps using "Previous" and "Next" buttons


		At any time, users can manually restart completed tours from their [user settings]([[= user_doc =]]/getting_started/get_started/#user-settings).

		To start building your custom onboarding scenarios, see [configure product tour](configure_product_tour.md).


		# Product tour

		Product tour is an in-app onboarding tool that helps users discover and learn [[= product_name =]] features through interactive, step-by-step guided walkthroughs.

Conversation

mnocon commented Feb 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Feb 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Preview of modified files

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 31, 2026

code_samples/ change report

Uh oh!

sonarqubecloud bot commented Mar 31, 2026

Quality Gate passed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mnocon commented Feb 18, 2026 •

edited

Loading

github-actions bot commented Feb 18, 2026 •

edited

Loading