You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/administration/back_office/customize_integrated_help.md
+14-3Lines changed: 14 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,20 +6,31 @@ month_change: true
6
6
7
7
# Customize integrated help
8
8
9
-
The integrated help menu is part of the Integrated help introduced as an LTS Update.
9
+
The integrated help menu is part of the Integrated help introduced as an [LTS Update](editions.md#lts-updates).
10
10
By default, it provides editors and developers with convenient access to documentation, training and other resources directly from the back office.
11
11
12
12
You can extend or modify the integrated menu in two ways:
13
13
14
-
- by modifying a link to user documentation in a yaml file
14
+
- by disabling it for all users
15
+
- by modifying a link to user documentation
15
16
- by subscribing to the `ibexa_integrated_help.menu_configure.help_menu` event
16
17
18
+
## Disable integrated help for all users
19
+
20
+
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).
21
+
To do it, in `config/packages` create the `ibexa_integrated_help.yaml` file, with the following configuration:
22
+
23
+
```yaml
24
+
ibexa_integrated_help:
25
+
is_enabled: false
26
+
```
27
+
17
28
## Modify user documentation link
18
29
19
30
[[= product_name =]] provides a comfortable method for replacing a link to user documentation, when you do not want to modify the rest of the integrated help menu.
20
31
This way you can direct application users such as editors or store managers to specific guidelines in force at your organization, without having to resort to development.
21
32
22
-
To do in, in `config/packages` create the `ibexa_integrated_help.yaml` file, with the following configuration:
33
+
To do it, in `config/packages` create the `ibexa_integrated_help.yaml` file, with the following configuration:
Copy file name to clipboardExpand all lines: docs/administration/back_office/integrated_help.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,12 @@
1
1
---
2
2
description: Integrated help provides quick access to documentation, training, and support resources.
3
+
edition: lts-update
3
4
month_change: true
4
5
---
5
6
6
7
# Integrated help
7
8
8
-
Integrated help is an LTS Update that brings documentation, training resources and product roadmap-related information into the back office.
9
+
Integrated help is an [LTS Update](editions.md#lts-updates) that brings documentation, training resources and product roadmap-related information into the back office.
9
10
With this feature installed, users can click the {.inline-image} icon to access relevant content straight from the UI.
10
11
11
12

0 commit comments