Skip to content

IBX-10163: Document integrated help - #2937

Merged
mnocon merged 7 commits into
5.0from
IBX-10163
Dec 10, 2025
Merged

mnocon merged 7 commits into
5.0from
IBX-10163

Conversation

@dabrt

@dabrt dabrt commented Oct 16, 2025

Copy link
Copy Markdown
Contributor
Question Answer
JIRA Ticket IBX-10163
Versions 4.6, 5.0
Edition all

Document the integrated help LTS update

TODO:
1. Move code samples to relevant external files
2. Replace mockups with actual screenshots

Checklist

  • Text renders correctly
  • Text has been checked with vale
  • Description metadata is up to date
  • PHP code samples have been fixed with PHP CS fixer
  • Added link to this PR in relevant JIRA ticket or code PR

@github-actions

Copy link
Copy Markdown

Comment thread docs/administration/back_office/customize_integrated_help.md Outdated
Comment thread docs/administration/back_office/customize_integrated_help.md Outdated
Comment thread docs/administration/back_office/customize_integrated_help.md Outdated
Comment thread docs/administration/back_office/customize_integrated_help.md Outdated
Comment thread docs/administration/back_office/customize_integrated_help.md Outdated
@dabrt
dabrt requested a review from wiewiurdp October 16, 2025 15:27

@mnocon mnocon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only one minor question 😉

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the point of this file?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NVM, I see thay that it's inlined into the article, that's ok

@dabrt dabrt added Wait with merge PRs that shouldn't be merged instantly and removed Needs DOC review labels Nov 14, 2025
@github-actions

github-actions Bot commented Dec 8, 2025

Copy link
Copy Markdown

code_samples/ change report

Before (on target branch)After (in current PR)

code_samples/back_office/menu/menu_item/src/EventSubscriber/HelpMenuSubscriber.php


code_samples/back_office/menu/menu_item/src/EventSubscriber/HelpMenuSubscriber.php

docs/administration/back_office/customize_integrated_help.md@83:``` php
docs/administration/back_office/customize_integrated_help.md@84:[[= include_file('code_samples/back_office/menu/menu_item/src/EventSubscriber/HelpMenuSubscriber.php') =]]
docs/administration/back_office/customize_integrated_help.md@85:```

001⫶<?php
002⫶
003⫶declare(strict_types=1);
004⫶
005⫶namespace App\EventSubscriber;
006⫶
007⫶use Symfony\Component\EventDispatcher\EventSubscriberInterface;
008⫶use Symfony\Contracts\EventDispatcher\Event;
009⫶
010⫶final class HelpMenuSubscriber implements EventSubscriberInterface
011⫶{
012⫶ public function __construct(
013⫶ private readonly bool $kernelDebug
014⫶ ) {
015⫶ }
016⫶
017⫶ public static function getSubscribedEvents(): array
018⫶ {
019⫶ return [
020⫶ 'ibexa_integrated_help.menu_configure.help_menu' => 'onHelpMenuConfigure',
021⫶ ];
022⫶ }
023⫶
024⫶ public function onHelpMenuConfigure(Event $event): void
025⫶ {
026⫶ $menu = $event->getMenu();
027⫶
028⫶ // Remove roadmap menu item
029⫶ if ($menu->getChild('help__general')) {
030⫶ $generalSection = $menu->getChild('help__general');
031⫶ if ($generalSection->getChild('help__product_roadmap')) {
032⫶ $generalSection->removeChild('help__product_roadmap');
033⫶ }
034⫶ }
035⫶
036⫶ // Add videos tab, shown only in production
037⫶ if ($this->kernelDebug === false) {
038⫶ $resourcesSection = $menu->addChild('help__videos', [
039⫶ 'label' => 'Product videos',
040⫶ ]);
041⫶
042⫶ $resourcesSection->addChild('help__webinar_v5', [
043⫶ 'label' => 'Webinar: Introducing Ibexa DXP v5',
044⫶ 'uri' => 'https://www.youtube.com/watch?v=qWaBHG2LRm8',
045⫶ 'extras' => [
046⫶ 'isHighlighted' => false,
047⫶ 'icon' => 'https://doc.ibexa.co/en/5.0/templating/twig_function_reference/img/icons/video.svg.png',
048⫶ 'description' => 'Discover new features and improvements brought by Ibexa DXP v5.',
049⫶ ],
050⫶ ]);
051⫶ }
052⫶ }
053⫶}

Download colorized diff

@mnocon
mnocon merged commit b66ca80 into 5.0 Dec 10, 2025
3 of 6 checks passed
@mnocon
mnocon deleted the IBX-10163 branch December 10, 2025 14:02
mnocon added a commit that referenced this pull request Dec 10, 2025
* IBX-10163: Document integrated help

* Change the metadata in the "customize" article

* Implement review comments

* Move code to a separate file

* PHP & JS CS Fixes

* Describe global disable option

* Mention user settings and adjust config key to enable

---------

Co-authored-by: dabrt <dabrt@users.noreply.github.com>
Co-authored-by: Marek Nocoń <mnocon@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Wait with merge PRs that shouldn't be merged instantly

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants