Skip to content

Commit bc3f882

Browse files
julitafalconduszajulitafalcondusza
committed
IBX-8917: Content fixes in Developer Documentation (#2506)
* Content updates, capitalization fixes * New fixes * New fixes * New fixes * New fixes * Fixes * Typo fix * Field -> field * Capitalization fixes * Fixes * Fixes * Fixes * Fixes * Fixes * Fixes * Variables fix * More fixes * More fixes * More fixes * Batch of fixes * Tabs fixes * 'Will' fixes * 'Won't' fixes * 'e.g.' fixes * Fixes in 'back office' section * Fixes in 'configuration' section * Fixes in 'content organization' section * Fixes * Fixes in'api' section * Fixes in 'cdp' section * Fixes in 'commerce' * Fixes in 'content management' section * Fixes in 'customer management' * Fixes in 'getting started' section * Fixes in 'ibexa cloud' * Fixes in 'ibexa engage' section * Fixes in 'ibexa products' section * Fixes in 'cache' section * Fixes in 'clustering' * Fixes in 'security' * Fixes in 'infrastructure' section * Fixes in 'languages' * Fixes in 'site factory and siteaccess' sections * Fixes in 'multisite' * Fixes in 'permissions' section * Fixes in 'personalization' * Fixes in 'pim' * Fixes in 'resources' * Fixes in 'search references' and aggregations * Fixes in 'search' * Fixes in 'snippets' * Fixes in 'templates' * Fixes in 'tutorials' * Fixes in 'users' * Fixes - 'field' * Fixes - 'section' * Fixes - 'location' * Fixes - 'subtree' * Fixes - 'value object' * Fixes - 'search criteria' * Fixes - 'product' * Fixes - 'sort clauses' * Fixes - 'elasticsearch' * Fix 'storefront' * Fixes - 'etc.' * Fixes - 'policies' * Fixes * Fixes * Fixes * Fixes * Fixes * Links fixed (variables removed) * Fixes after review * Fixes after review * Revert changes in api .raml and .html files * fix * fixes
1 parent 15c5dae commit bc3f882

File tree

683 files changed

+7276
-7509
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

683 files changed

+7276
-7509
lines changed

‎docs/administration/admin_panel/admin_panel.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
description: Ibexa DXP Back Office contains managements options for permissions, users, languages, content types, as well as system information.
2+
description: Ibexa DXP back office contains managements options for permissions, users, languages, content types, and system information.
33
page_type: landing_page
44
---
55

66
# Admin panel
77

88
Once you set up your environment you can start your work as an administrator.
9-
Your most useful tools can be found in **Admin Panel**.
9+
You can find key tools in **Admin** panel.
1010

11-
To access Admin Panel, click the icon: ![Admin Panel Icon](admin_panel_icon.png){.inline-image}.
11+
To access **Admin** panel, click the icon: ![Admin panel Icon](admin_panel_icon.png){.inline-image}.
1212

1313
[[= cards([
1414
"administration/admin_panel/users_admin_panel",
@@ -18,5 +18,5 @@ To access Admin Panel, click the icon: ![Admin Panel Icon](admin_panel_icon.png)
1818
"administration/admin_panel/segments_admin_panel",
1919
"administration/admin_panel/corporate_admin_panel",
2020
"administration/admin_panel/workflow_admin_panel",
21-
"administration/admin_panel/system_information_admin_panel",
21+
"administration/admin_panel/system_information_admin_panel",
2222
], columns=4) =]]

‎docs/administration/admin_panel/corporate_admin_panel.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,10 @@ description: You can manage companies profiles in the Admin Panel.
44

55
# Corporate
66

7-
You can manage companies profiles in the Admin Panel.
7+
You can manage companies profiles in the **Admin** panel.
88

9-
There, in the **Corporate** section, you can find basic information about existing companies,
10-
for example, details, versions, locations, translations, a list of members, billing addresses
11-
and technical details regarding the organization, such as visibility, IDs, or relations.
9+
There, in the **Corporate** section, you can find basic information about existing companies, for example, details, versions, locations, translations, a list of members, billing addresses, and technical details regarding the organization, such as visibility, IDs, or relations.
1210

1311
![Corporate section](admin_panel_corporate.png "Corporate section")
1412

15-
See [Customer management](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/manage_customers/) for further information.
13+
For more information, see [Customer management](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/manage_customers/).

‎docs/administration/admin_panel/languages_admin_panel.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,14 @@ description: Ibexa DXP offers the ability to create multiple translations of you
66

77
[[= product_name =]] offers the ability to create multiple translations of your website.
88
Which version is shown to a visitor depends on the way your installation is set up.
9-
A new language version for the website can be added in the [Admin Panel](admin_panel.md) in the **Languages** tab.
9+
You can add a new language version for the website in the [Admin Panel](admin_panel.md) in the **Languages** tab.
1010

11-
Every new language must have a name and a language code, written in the `xxx-XX` format, for example `eng-GB` etc.
11+
Every new language must have a name and a language code, written in the `xxx-XX` format, for example `eng-GB`.
1212

1313
![Languages](admin_panel_languages.png "Languages")
1414

15-
The multilanguage system operates based on a global translation list
16-
that contains all languages available in the installation.
15+
The multilanguage system operates based on a global translation list that contains all languages available in the installation.
1716
After adding a language you may have to reload the application to be able to use it.
18-
Depending on your set up, additional configuration may be necessary
19-
for the new language to work properly, especially with SiteAccesses.
17+
Depending on your set up, additional configuration may be necessary for the new language to work properly, especially with SiteAccesses.
2018

2119
See [Languages](languages.md) for further information.

‎docs/administration/admin_panel/roles_admin_panel.md‎

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,44 @@
11
---
2-
description: To give users an access to your website you need to assign them Roles in the Admin Panel.
2+
description: To give users an access to your website you need to assign them roles in the Admin Panel.
33
---
44

55
# Roles
66

7-
To give users an access to your website you need to assign them Roles in the Admin Panel.
7+
To give users an access to your website you need to assign them roles in the **Admin** panel.
88

99
![Roles](admin_panel_roles.png "Roles")
1010

11-
Each Role consists of:
11+
Each role consists of:
1212

1313
**Policies**
1414

1515
![Policies](admin_panel_policies.png "Policies")
1616

17-
Rules that give users access to different function in a module.
18-
You can restrict what user can do with Limitations.
19-
The available Limitations depend on the chosen Policy.
20-
When Policy has more than one Limitation, all of them have to apply.
17+
Policies are the rules that give users access to different function in a module.
18+
You can restrict what user can do with limitations.
19+
The available limitations depend on the chosen policy.
20+
When policy has more than one limitation, all of them have to apply.
2121
See [example use case](permission_use_cases.md#restrict-editing-to-part-of-the-tree).
2222

2323
!!! note
2424

25-
Limitation specifies what a User can do, not what they can't do.
26-
A `Location` Limitation, for example, gives the User access to content with a specific Location,
27-
not prohibits it. See [Limitation reference](limitation_reference.md) for further information.
25+
Limitation specifies what a user can do, not what they can't do.
26+
A `Location` limitation, for example, gives the user access to content with a specific location, not prohibits it.
27+
28+
For more information, see [Limitation reference](limitation_reference.md).
2829

2930
**Assignments**
3031

3132
![Assignments](admin_panel_assignments.png "Assignments")
3233

33-
After you created all Policies, you can assign the Role to Users and/or User Groups with possible additional Limitations.
34-
Every User or User Group can have multiple Roles.
35-
A User can also belong to many groups, for example, Administrators, Editors, Subscribers.
34+
After you created all policies, you can assign the role to users and/or user groups with possible additional limitations.
35+
Every user or user group can have multiple roles.
36+
A user can also belong to many groups, for example, Administrators, Editors, Subscribers.
3637

37-
Best practice is to avoid assigning Roles to Users directly.
38-
Model your content (content types, Sections, Locations etc.) in a way that can be accessed by generic Roles.
39-
That way system will be more secure and easier to manage.
40-
This approach also improves performance. Role assignments and Policies are taken into account during search/load queries.
38+
Best practice is to avoid assigning roles to users directly.
39+
Model your content (for example, content types, sections, or locations) in a way that can be accessed by generic roles.
40+
That way system is be more secure and easier to manage.
41+
This approach also improves performance.
42+
Role assignments and policies are taken into account during search/load queries.
4143

42-
See [Permissions overview](permissions.md) for further information
43-
and [Permission use cases](permission_use_cases.md) for details on how to customize access to different parts of the Back Office.
44+
For more information, see [Permissions overview](permissions.md) and [Permission use cases](permission_use_cases.md).

‎docs/administration/admin_panel/segments_admin_panel.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
2-
description: You can use Segments to display specific content to specific Users.
2+
description: You can use segments to display specific content to specific users.
33
edition: experience
44
---
55

66
# Segments
77

8-
You can use Segments to display specific content to specific [Users](users.md).
9-
They are used out of the box in the Targeting and Dynamic targeting blocks in the Page.
8+
You can use segments to display specific content to specific [users](users.md).
9+
They're used out of the box in the Targeting and Dynamic targeting blocks in the page.
1010

11-
Segments are collected in Segment Groups:
11+
You can collect segments in segment groups:
1212

13-
![Segment Groups](admin_panel_segment_groups.png)
13+
![Segment groups](admin_panel_segment_groups.png)
1414

15-
Each Segment Group can contain Segments that you can target content for.
15+
Each segment group can contain segments that you can target content for.
1616

1717
![Segment](admin_panel_segment.png)
1818

19-
You can assign Users to Segments [through the API](segment_api.md#assigning-users).
19+
You can assign users to segments [through the API](segment_api.md#assigning-users).

‎docs/administration/admin_panel/system_information_admin_panel.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: System information provides basic system information such as versio
44

55
# System Information
66

7-
The System Information panel in the Back Office is sourced in the [`ibexa/system-info` repository](https://github.com/ibexa/system-info).
8-
There you will also find basic system information such as versions of all installed packages.
7+
The System Information panel in the back office is sourced in the [`ibexa/system-info` repository](https://github.com/ibexa/system-info).
8+
There you can also find basic system information such as versions of all installed packages.
99

1010
![System Information](admin_panel_system_info.png "System Information")

‎docs/administration/admin_panel/url_management_admin_panel.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
description: URL Management let you manage external URL addresses and URL wildcards.
2+
description: URL Management lets you manage external URL addresses and URL wildcards.
33
---
44

55
# URL Management
66

7-
You can manage external URL addresses and URL wildcards in the Admin Panel.
7+
You can manage external URL addresses and URL wildcards in the **Admin** panel.
88
Configure URL aliases to have human-readable URL addresses throughout your system.
99

10-
See [URL management](url_management.md) for further information.
10+
For more information, see [URL management](url_management.md).
1111

1212
![URL Management](admin_panel_url_management.png "URL Management")

‎docs/administration/admin_panel/users_admin_panel.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
---
2-
description: All User Groups and Users can be accessed in the Users tab.
2+
description: You can access all users and user groups in the Users tab.
33
---
44

55
# Users
66

77
[Users](users.md) in [[= product_name =]] are treated the same way as content items.
8-
They are organized in groups such as *Guests*, *Editors*, *Anonymous*,
9-
which makes it easier to manage them and their permissions.
10-
All User Groups and Users can be accessed in the Admin panel by selecting Users.
8+
They're organized in groups such as *Guests*, *Editors*, *Anonymous*, which makes it easier to manage them and their permissions.
9+
You can access all users and user groups in the **Admin** panel by selecting **Users**.
1110

12-
![Users and User Groups](admin_panel_users.png "Users and User Groups")
11+
![Users and user groups](admin_panel_users.png "Users and user groups")
1312

1413
!!! caution
1514

16-
Be careful not to delete an existing User account.
17-
If you do this, content created by this User will be broken and the application can face malfunction.
15+
Be careful not to delete an existing user account.
16+
If you do this, content created by this user can be broken and the application can face malfunction.

‎docs/administration/admin_panel/workflow_admin_panel.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ description: The workflow functionality passes a content item version through a
77
The workflow functionality passes a content item version through a series of stages.
88
Each workflow consists of stages and transitions between them.
99

10-
See [Workflow](workflow.md) for further information.
10+
For more information, see [Workflow](workflow.md).
1111

1212
![Workflow](admin_panel_workflow.png "Workflow")

‎docs/administration/back_office/add_user_setting.md‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,13 @@ description: Add the option to select a custom preference in user menu.
44

55
# Add user setting
66

7-
## Create new User setting
7+
## Create new user setting
88

9-
You can add new preferences to the **User Settings** menu in the Back Office.
9+
You can add new preferences to the **User Settings** menu in the back office.
1010

11-
To do so, create a setting class implementing two interfaces:
12-
`ValueDefinitionInterface` and `FormMapperInterface`.
11+
To do so, create a setting class implementing two interfaces: `ValueDefinitionInterface` and `FormMapperInterface`.
1312

14-
In this example the class is located in `src/Setting/Unit.php`
15-
and enables the user to select their preference for metric or imperial unit systems.
13+
In this example the class is located in `src/Setting/Unit.php` and enables the user to select their preference for metric or imperial unit systems.
1614

1715
``` php
1816
[[= include_file('code_samples/back_office/settings/src/Setting/Unit.php') =]]
@@ -24,7 +22,7 @@ Register the setting as a service:
2422
[[= include_file('code_samples/back_office/settings/config/custom_services.yaml', 0, 5) =]]
2523
```
2624

27-
You can order the settings in the User menu by setting their `priority`.
25+
You can order the settings in the **User** menu by setting their `priority`.
2826

2927
`group` indicates the group that the setting is placed in.
3028
It can be one of the built-in groups, or a custom one.
@@ -45,8 +43,7 @@ The value of the setting is accessible with `ez_user_settings['unit']`.
4543

4644
## Create template for editing settings
4745

48-
You can override a template used when editing the new setting
49-
under the `ibexa.system.<scope>.user_settings_update_view` [configuration key](configuration.md#configuration-files):
46+
You can override a template used when editing the new setting under the `ibexa.system.<scope>.user_settings_update_view` [configuration key](configuration.md#configuration-files):
5047

5148
``` yaml
5249
[[= include_file('code_samples/back_office/settings/config/packages/user_settings.yaml') =]]

0 commit comments

Comments
 (0)