Skip to content

Commit 5971da4

Browse files
committed
Describe global disable option
1 parent 4230efd commit 5971da4

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

docs/administration/back_office/customize_integrated_help.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,31 @@ month_change: true
66

77
# Customize integrated help
88

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).
1010
By default, it provides editors and developers with convenient access to documentation, training and other resources directly from the back office.
1111

1212
You can extend or modify the integrated menu in two ways:
1313

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
1516
- by subscribing to the `ibexa_integrated_help.menu_configure.help_menu` event
1617

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+
1728
## Modify user documentation link
1829
1930
[[= 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.
2031
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.
2132
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:
2334

2435
``` yaml
2536
ibexa_integrated_help:

docs/administration/back_office/integrated_help.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
description: Integrated help provides quick access to documentation, training, and support resources.
3+
edition: lts-update
34
month_change: true
45
---
56

67
# Integrated help
78

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.
910
With this feature installed, users can click the ![Help icon](about-info.png){.inline-image} icon to access relevant content straight from the UI.
1011

1112
![Integrated help menu](5_0_integrated_help_menu.png)

0 commit comments

Comments
 (0)