Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
80 commits
Select commit Hold shift + click to select a range
2abc3ef
Content updates, capitalization fixes
julitafalcondusza Oct 3, 2024
7255d1a
New fixes
julitafalcondusza Oct 9, 2024
2a2efd2
New fixes
julitafalcondusza Oct 9, 2024
60a52f8
New fixes
julitafalcondusza Oct 10, 2024
2f6e6de
New fixes
julitafalcondusza Oct 10, 2024
880aa0a
Fixes
julitafalcondusza Oct 11, 2024
1bf737c
Typo fix
julitafalcondusza Oct 11, 2024
c880dda
Field -> field
julitafalcondusza Oct 11, 2024
705aa0f
Capitalization fixes
julitafalcondusza Oct 11, 2024
5388580
Fixes
julitafalcondusza Oct 11, 2024
44e0229
Fixes
julitafalcondusza Oct 11, 2024
fa50644
Fixes
julitafalcondusza Oct 14, 2024
88aac46
Fixes
julitafalcondusza Oct 15, 2024
6c158a1
Fixes
julitafalcondusza Oct 15, 2024
94f89b4
Fixes
julitafalcondusza Oct 15, 2024
28c7a8f
Variables fix
julitafalcondusza Oct 15, 2024
99a61d9
More fixes
julitafalcondusza Oct 15, 2024
5602150
More fixes
julitafalcondusza Oct 15, 2024
7679df7
More fixes
julitafalcondusza Oct 15, 2024
dd8018e
Batch of fixes
julitafalcondusza Oct 15, 2024
447a3f5
Tabs fixes
julitafalcondusza Oct 16, 2024
089c485
'Will' fixes
julitafalcondusza Oct 16, 2024
ccdc2f0
'Won't' fixes
julitafalcondusza Oct 16, 2024
9a8a1d2
'e.g.' fixes
julitafalcondusza Oct 16, 2024
b598eac
Fixes in 'back office' section
julitafalcondusza Oct 16, 2024
2c1ee6b
Fixes in 'configuration' section
julitafalcondusza Oct 16, 2024
048289e
Fixes in 'content organization' section
julitafalcondusza Oct 16, 2024
cfc3b8d
Fixes
julitafalcondusza Oct 16, 2024
078e3cb
Fixes in'api' section
julitafalcondusza Oct 16, 2024
3dea47d
Fixes in 'cdp' section
julitafalcondusza Oct 16, 2024
2bc4569
Fixes in 'commerce'
julitafalcondusza Oct 16, 2024
7b02cc2
Fixes in 'content management' section
julitafalcondusza Oct 16, 2024
710d12b
Fixes in 'customer management'
julitafalcondusza Oct 16, 2024
18e811a
Fixes in 'getting started' section
julitafalcondusza Oct 16, 2024
ae3a32a
Fixes in 'ibexa cloud'
julitafalcondusza Oct 16, 2024
8dbc2cb
Fixes in 'ibexa engage' section
julitafalcondusza Oct 16, 2024
8c5b5ec
Fixes in 'ibexa products' section
julitafalcondusza Oct 16, 2024
abe6688
Fixes in 'cache' section
julitafalcondusza Oct 16, 2024
eda8f76
Fixes in 'clustering'
julitafalcondusza Oct 16, 2024
9011431
Fixes in 'security'
julitafalcondusza Oct 16, 2024
e49efef
Fixes in 'infrastructure' section
julitafalcondusza Oct 16, 2024
d7460c9
Fixes in 'languages'
julitafalcondusza Oct 16, 2024
806aff1
Fixes in 'site factory and siteaccess' sections
julitafalcondusza Oct 16, 2024
8c106c4
Fixes in 'multisite'
julitafalcondusza Oct 17, 2024
6baff1a
Fixes in 'permissions' section
julitafalcondusza Oct 17, 2024
2c62c4a
Fixes in 'personalization'
julitafalcondusza Oct 17, 2024
1d6e23d
Fixes in 'pim'
julitafalcondusza Oct 17, 2024
41111e5
Fixes in 'resources'
julitafalcondusza Oct 17, 2024
ed5398e
Fixes in 'search references' and aggregations
julitafalcondusza Oct 17, 2024
abf65fb
Fixes in 'search'
julitafalcondusza Oct 17, 2024
db45a5c
Fixes in 'snippets'
julitafalcondusza Oct 17, 2024
ec4ce77
Fixes in 'templates'
julitafalcondusza Oct 17, 2024
32f607d
Fixes in 'tutorials'
julitafalcondusza Oct 17, 2024
ee63515
Fixes in 'users'
julitafalcondusza Oct 17, 2024
201c7ad
Fixes - 'field'
julitafalcondusza Oct 17, 2024
e369186
Fixes - 'section'
julitafalcondusza Oct 17, 2024
9b5d492
Fixes - 'location'
julitafalcondusza Oct 17, 2024
318f125
Fixes - 'subtree'
julitafalcondusza Oct 17, 2024
66d1650
Fixes - 'value object'
julitafalcondusza Oct 17, 2024
0530436
Fixes - 'search criteria'
julitafalcondusza Oct 17, 2024
fb4797e
Fixes - 'product'
julitafalcondusza Oct 17, 2024
74e997e
Fixes - 'sort clauses'
julitafalcondusza Oct 17, 2024
66da5a5
Fixes - 'elasticsearch'
julitafalcondusza Oct 17, 2024
f2ff5d6
Fix 'storefront'
julitafalcondusza Oct 17, 2024
a7c3cb9
Fixes - 'etc.'
julitafalcondusza Oct 17, 2024
45a74b3
Fixes - 'policies'
julitafalcondusza Oct 17, 2024
7f8e4c8
Fixes
julitafalcondusza Oct 17, 2024
d4b6fff
Fixes
julitafalcondusza Oct 17, 2024
9bb7b01
Fixes
julitafalcondusza Oct 17, 2024
5a99844
Fixes
julitafalcondusza Oct 17, 2024
f8fe289
Fixes
julitafalcondusza Oct 17, 2024
a9bd8f1
Links fixed (variables removed)
julitafalcondusza Oct 17, 2024
7fa6f16
Merge branch 'master' into IBX-8917
julitafalcondusza Oct 17, 2024
ac5d231
Fixes after review
julitafalcondusza Nov 25, 2024
6f77524
Fixes after review
julitafalcondusza Nov 25, 2024
e524c96
Revert changes in api .raml and .html files
julitafalcondusza Nov 26, 2024
5ce27af
fix
julitafalcondusza Nov 26, 2024
4fc5f62
Merge remote-tracking branch 'origin/master' into IBX-8917
julitafalcondusza Nov 27, 2024
702ff7a
Merge branch 'master' into IBX-8917
julitafalcondusza Nov 27, 2024
364ab9f
fixes
julitafalcondusza Nov 28, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 4 additions & 4 deletions docs/administration/admin_panel/admin_panel.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
description: Ibexa DXP Back Office contains managements options for permissions, users, languages, content types, as well as system information.
description: Ibexa DXP back office contains managements options for permissions, users, languages, content types, and system information.
page_type: landing_page
---

# Admin panel

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

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

[[= cards([
"administration/admin_panel/users_admin_panel",
Expand All @@ -18,5 +18,5 @@ To access Admin Panel, click the icon: ![Admin Panel Icon](admin_panel_icon.png)
"administration/admin_panel/segments_admin_panel",
"administration/admin_panel/corporate_admin_panel",
"administration/admin_panel/workflow_admin_panel",
"administration/admin_panel/system_information_admin_panel",
"administration/admin_panel/system_information_admin_panel",
], columns=4) =]]
8 changes: 3 additions & 5 deletions docs/administration/admin_panel/corporate_admin_panel.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,10 @@ description: You can manage companies profiles in the Admin Panel.

# Corporate

You can manage companies profiles in the Admin Panel.
You can manage companies profiles in the **Admin** panel.

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.
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.

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

See [Customer management](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/manage_customers/) for further information.
For more information, see [Customer management](https://doc.ibexa.co/projects/userguide/en/latest/customer_management/manage_customers/).
10 changes: 4 additions & 6 deletions docs/administration/admin_panel/languages_admin_panel.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,14 @@ description: Ibexa DXP offers the ability to create multiple translations of you

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

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

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

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

See [Languages](languages.md) for further information.
39 changes: 20 additions & 19 deletions docs/administration/admin_panel/roles_admin_panel.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,44 @@
---
description: To give users an access to your website you need to assign them Roles in the Admin Panel.
description: To give users an access to your website you need to assign them roles in the Admin Panel.
---

# Roles

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

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

Each Role consists of:
Each role consists of:

**Policies**

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

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

!!! note

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

For more information, see [Limitation reference](limitation_reference.md).

**Assignments**

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

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

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

See [Permissions overview](permissions.md) for further information
and [Permission use cases](permission_use_cases.md) for details on how to customize access to different parts of the Back Office.
For more information, see [Permissions overview](permissions.md) and [Permission use cases](permission_use_cases.md).
14 changes: 7 additions & 7 deletions docs/administration/admin_panel/segments_admin_panel.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
description: You can use Segments to display specific content to specific Users.
description: You can use segments to display specific content to specific users.
edition: experience
---

# Segments

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

Segments are collected in Segment Groups:
You can collect segments in segment groups:

![Segment Groups](admin_panel_segment_groups.png)
![Segment groups](admin_panel_segment_groups.png)

Each Segment Group can contain Segments that you can target content for.
Each segment group can contain segments that you can target content for.

![Segment](admin_panel_segment.png)

You can assign Users to Segments [through the API](segment_api.md#assigning-users).
You can assign users to segments [through the API](segment_api.md#assigning-users).
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: System information provides basic system information such as versio

# System Information

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

![System Information](admin_panel_system_info.png "System Information")
6 changes: 3 additions & 3 deletions docs/administration/admin_panel/url_management_admin_panel.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
description: URL Management let you manage external URL addresses and URL wildcards.
description: URL Management lets you manage external URL addresses and URL wildcards.
---

# URL Management

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

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

![URL Management](admin_panel_url_management.png "URL Management")
13 changes: 6 additions & 7 deletions docs/administration/admin_panel/users_admin_panel.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
---
description: All User Groups and Users can be accessed in the Users tab.
description: You can access all users and user groups in the Users tab.
---

# Users

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

![Users and User Groups](admin_panel_users.png "Users and User Groups")
![Users and user groups](admin_panel_users.png "Users and user groups")

!!! caution

Be careful not to delete an existing User account.
If you do this, content created by this User will be broken and the application can face malfunction.
Be careful not to delete an existing user account.
If you do this, content created by this user can be broken and the application can face malfunction.
2 changes: 1 addition & 1 deletion docs/administration/admin_panel/workflow_admin_panel.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ description: The workflow functionality passes a content item version through a
The workflow functionality passes a content item version through a series of stages.
Each workflow consists of stages and transitions between them.

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

![Workflow](admin_panel_workflow.png "Workflow")
15 changes: 6 additions & 9 deletions docs/administration/back_office/add_user_setting.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,13 @@ description: Add the option to select a custom preference in user menu.

# Add user setting

## Create new User setting
## Create new user setting

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

To do so, create a setting class implementing two interfaces:
`ValueDefinitionInterface` and `FormMapperInterface`.
To do so, create a setting class implementing two interfaces: `ValueDefinitionInterface` and `FormMapperInterface`.

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.
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.

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

You can order the settings in the User menu by setting their `priority`.
You can order the settings in the **User** menu by setting their `priority`.

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

## Create template for editing settings

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):
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):

``` yaml
[[= include_file('code_samples/back_office/settings/config/packages/user_settings.yaml') =]]
Expand Down
15 changes: 6 additions & 9 deletions docs/administration/back_office/back_office.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,21 @@
---
description: Back Office holds the administrator and editor interface and allows creating, publishing and managing content, users, settings and so on.
description: Back office holds the administrator and editor interface and allows creating, publishing and managing content, users, settings, and more.
page_type: landing_page
---

# Back Office
# Back office

The Back Office interface is produced by the [`ibexa/admin-ui` bundle](https://github.com/ibexa/admin-ui).
The back office interface is produced by the [`ibexa/admin-ui` bundle](https://github.com/ibexa/admin-ui).
Additionally, it uses React-based modules that make each part of the UI extensible, and Bootstrap for styling.
The interface is accessible in your browser at `http://<yourdomain>/admin`.

To extend the Back Office with PHP code, you can use [events]([[= symfony_doc =]]/event_dispatcher.html),
either built-in Symfony events or events dispatched by the application.
To extend the back office with PHP code, you can use [events]([[= symfony_doc =]]/event_dispatcher.html), either built-in Symfony events or events dispatched by the application.

Some extensibility, such as [adding custom tags](extend_online_editor.md#configure-custom-tags),
is possible without writing your own code, with configuration and templating only.
Some extensibility, such as [adding custom tags](extend_online_editor.md#configure-custom-tags), is possible without writing your own code, with configuration and templating only.

!!! note "String translations"

Refer to [Custom string translations](back_office_translations.md#custom-string-translations)
to learn how to provide string translations when extending the Back Office.
Refer to [Custom string translations](back_office_translations.md#custom-string-translations) to learn how to provide string translations when extending the back office.

[[= cards([
"administration/back_office/back_office_configuration",
Expand Down
22 changes: 9 additions & 13 deletions docs/administration/back_office/back_office_configuration.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Back Office configuration
description: Configure default upload locations, pagination limits, and more settings for the Back Office.
title: Back office configuration
description: Configure default upload locations, pagination limits, and more settings for the back office.
---

# Back Office configuration
# Back office configuration

## Pagination limits

Default pagination limits for different sections of the Back Office can be defined through respective settings in
Default pagination limits for different sections of the back office can be defined through respective settings in
[`ezplatform_default_settings.yaml`](https://github.com/ibexa/admin-ui/blob/main/src/bundle/Resources/config/ezplatform_default_settings.yaml#L7)

You can set the pagination limit for user settings under the `ibexa.system.<scope>.pagination_user` [configuration key](configuration.md#configuration-files):
Expand Down Expand Up @@ -41,19 +41,15 @@ ibexa:

## Copy subtree limit

Copying large subtrees can cause performance issues, so you can limit the number of content items
that can be copied at once using the `ibexa.system.<scope>.subtree_operations.copy_subtree.limit`
[configuration key](configuration.md#configuration-files).
Copying large subtrees can cause performance issues, so you can limit the number of content items that can be copied at once by setting the `ibexa.system.<scope>.subtree_operations.copy_subtree.limit` [configuration key](configuration.md#configuration-files).

The default value is `100`. You can set it to `-1` for no limit,
or to `0` to completely disable copying subtrees.
The default value is `100`. You can set it to `-1` for no limit, or to `0` to completely disable copying subtrees.

You can copy subtree from CLI using the command: `bin/console ibexa:copy-subtree <sourceLocationId> <targetLocationId>`.
You can copy a subtree by calling the following command in CLI: `bin/console ibexa:copy-subtree <sourceLocationId> <targetLocationId>`.

## Default Locations
## Default locations

Default Location IDs for [Content structure, Media and Users](locations.md#top-level-locations) in the menu are configured
using the `ibexa.system.<scope>.location_ids` [configuration key](configuration.md#configuration-files):
Default location IDs for [content structure, Media, and users](locations.md#top-level-locations) in the menu are configured with the `ibexa.system.<scope>.location_ids` [configuration key](configuration.md#configuration-files):

``` yaml
ibexa:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
description: Add custom drag-and-drop interactions to Back Office interface.
description: Add custom drag-and-drop interactions to back office interface.
---

# Add drag and drop

You can create a generic interface for drag and drop interactions that you can reuse in many places across the Back Office.
You can create a generic interface for drag and drop interactions that you can reuse in many places across the back office.

First, prepare the HTML code structure and place it in a Twig template. See the example:

```html
<div
<div
class="items-container-drag"
data-placeholder='<div class="item-placeholder-drag">item placeholder name</div>'
>
Expand Down
Loading
Loading