Skip to content

Commit 8fdf4b9

Browse files
dabrtmnocon
andcommitted
IBX-10163: Document integrated help (#378)
* IBX-10163: Document integrated help * Implement reviewer comments * Add LTS update badge * Add a link connecting the two articles * Update screenshots * Help center is disabled by default in the settings --------- Co-authored-by: Marek Nocoń <[email protected]>
1 parent 2a0a354 commit 8fdf4b9

File tree

5 files changed

+35
-7
lines changed

5 files changed

+35
-7
lines changed

docs/getting_started/discover_ui.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,3 +144,30 @@ Focus mode is enabled by default when you first log into [[= product_name =]], b
144144
- in the drop-down menu on the right side of the top bar
145145

146146
![Focus mode switch](img/FM_switch.png "Focus mode switch")
147+
148+
## Help center [[% include 'snippets/lts-update_badge.md' %]]
149+
150+
If the Integrated help [LTS update]([[= developer_doc =]]/ibexa_products/editions/#lts-updates) has been installed in your application, you may notice that the ![Help center](about-info.png){.inline-image} icon appears at the bottom right of multiple screens.
151+
Click it to access documentation, trainings, and other relevant resources straight from the back office.
152+
Help center is also [another place]([[= developer_doc =]]/administration/admin_panel/system_information_admin_panel/) where you can check the [[= product_name =]] version that you're on.
153+
154+
![Help center](img/help_center.png "Help center")
155+
156+
Contents of the help center are contextual:
157+
158+
- If you are an [editor](editor.md) or [store manager](shop_manager.md) working in a production environment, help center contains links to user documentation, release notes and product roadmap highlights.
159+
- If you are a developer whose task is to set up or extend the application, it additionally shows links to developer documentation, API references and the GraphQL console.
160+
161+
Help center can be [customized]([[= developer_doc =]]/administration/back_office/customize_integrated_help/) to fit the needs of your organization, for example, to include links to your internal style guides.
162+
163+
### Enable help center
164+
165+
Help center is disabled by default, but you can toggle it in [user settings](get_started.md#browsing).
166+
167+
### Dismiss help icon
168+
169+
It may happen that the help icon overlaps with other interface elements that you want to interact with.
170+
In such case, hover over the help icon and click the X icon to dismiss it.
171+
The help icon reappears when you reload the screen.
172+
173+
![Help obstructs UI](img/help_obstructs.png "Help obstructs UI")

docs/getting_started/get_started.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ You can access your user settings on the right side of the top bar:
9090

9191
Here you can [change your user password](get_started.md#change-the-password) and define your user preferences, such as preferred timezone, short and full date, and time format, or back office language.
9292

93-
**Location**
93+
#### Location
9494

9595
|Setting|Description|
9696
--------|-----------|
@@ -101,29 +101,30 @@ Here you can [change your user password](get_started.md#change-the-password) and
101101
|Full date and time format|Sets full date and time format used in the back office.|
102102
|Language|Sets the default language used in the back office.|
103103

104-
**Content authoring**
104+
#### Content authoring
105105

106106
|Setting|Description|
107107
--------|-----------|
108108
|[Autosave draft every given period](content_versions.md#autosave)|Enables or disables autosaving drafts.|
109109
|Seconds till next draft autosave|Sets time period for next autosave.|
110-
|Enable character count in online editor|Enables or disables charactes count.|
110+
|Enable character count in online editor|Enables or disables character count.|
111111
|Automatically open block settings in builders|Enables or disables the behavior of blocks used in builders.|
112112

113-
**Browsing**
113+
#### Browsing
114114

115115
|Setting|Description|
116116
--------|-----------|
117117
|Number of items displayed in the table|Sets the number of items displayed in sub-items.|
118-
|Location preview|Enables or disabled a thumbnail preview on the content tree.|
118+
|Location preview|Enables or disables a thumbnail preview on the content tree.|
119+
|Help center|Disables or enables the [help center](discover_ui.md#help-center). [[% include 'snippets/lts-update_badge.md' %]]|
119120

120-
**Mode**
121+
#### Mode
121122

122123
|Setting|Description|
123124
--------|-----------|
124125
|Focus mode|Enables or disables the [focus mode](discover_ui.md#focus-mode).|
125126

126-
**Dashboard**
127+
#### Dashboard
127128

128129
|Setting|Description|
129130
--------|-----------|
1.84 KB
Loading
166 KB
Loading
32.3 KB
Loading

0 commit comments

Comments
 (0)