Skip to content
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
f99fcc0
mkdocs.yml: target 3.3 instead of master
adriendupuis Feb 17, 2025
a022393
Merge branch '3.3' into fix-links-3.3
adriendupuis Feb 25, 2025
aa634c5
mkdocs.yml: symfony.com/doc/5.4 → 5.x
adriendupuis Feb 26, 2025
b6345e4
use [[= user_doc =]] to fix 3.3 links
adriendupuis Feb 26, 2025
eb5c83f
use [[= user_doc =]] to fix 3.3 links
adriendupuis Feb 26, 2025
65a5253
use [[= user_doc =]] to fix 3.3 links
adriendupuis Feb 26, 2025
7d21356
use [[= user_doc =]]
adriendupuis Feb 26, 2025
6b0bd14
mkdocs.yml + user_doc_4_6
adriendupuis Feb 27, 2025
9babee2
create_custom_page_block.md: user_doc_4_6 for doc not ported to 3.3
adriendupuis Feb 27, 2025
b544209
basic_integration.md: user_doc_4_6 for doc not ported to 3.3
adriendupuis Feb 27, 2025
2c9b9f5
content_api.md: Fix internal links
adriendupuis Feb 27, 2025
d3544e6
recommendation_api.md: Fix user doc links
adriendupuis Feb 27, 2025
8a74a1b
tracking_api.md: user_doc_4_6 for doc not ported to 3.3
adriendupuis Feb 27, 2025
d913e30
Fix some redirections to trailing slash
adriendupuis Feb 27, 2025
a22a76f
Fix several `[[= symfony_doc =]]` links
adriendupuis Mar 3, 2025
37cabc2
public_php_api_search.md: Fix ezsystems/ezplatform-kernel links
adriendupuis Mar 3, 2025
e0d6eaf
support_maintenance_faq.md: Fix links
adriendupuis Mar 3, 2025
373438d
extending_online_editor.md: Follow redirect
adriendupuis Mar 3, 2025
b30fea4
troubleshooting.md: use updates.ibexa.co with HTTPS
adriendupuis Mar 3, 2025
c062c93
Update twig.symfony.com links
adriendupuis Mar 3, 2025
76d1c4a
use https
adriendupuis Mar 3, 2025
397e5bc
persistence_cache.md: Update links
adriendupuis Mar 3, 2025
3806f5e
Update RFC links
adriendupuis Mar 3, 2025
3024888
rest_api_usage.md: Fix ISO 3166
adriendupuis Mar 3, 2025
cc33ccc
docs/guide/cache/*.md: Fix links
adriendupuis Mar 3, 2025
18e24ee
docs/guide/catalog/*.md: Fix links
adriendupuis Mar 3, 2025
20325d9
Fix links
adriendupuis Mar 3, 2025
6c7768b
docs/guide/payment/*.md: Fix links
adriendupuis Mar 3, 2025
8511fd5
Merge branch '3.3' into fix-links-3.3
adriendupuis Mar 5, 2025
cea1606
Twig doc 2.x → 3.x
adriendupuis Mar 5, 2025
9b22fdb
Do not change table formatting
adriendupuis Mar 5, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/guide/admin_panel.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Content Types are organized into groups.

You can add your own groups here to keep your Content Types in better order.

For a full tutorial, see [Create a Content Type](first_steps.md#create-a-content-type) or follow [user documentation](https://doc.ezplatform.com/projects/userguide/en/latest/organizing_the_site/#content-types).
For a full tutorial, see [Create a Content Type](first_steps.md#create-a-content-type) or follow [user documentation]([[= user_doc =]]/site_organization/organizing_the_site/#content-types).
For a detailed overview of the content model, see [Content model overview](content_model.md).

## Object States
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/content_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ It contains a User Group Content item.

#### Forms [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]]

**Forms** is the top level Location that is intended for Forms created using the [Form Builder](https://doc.ibexa.co/projects/userguide/en/3.3/creating_forms/).
**Forms** is the top level Location that is intended for Forms created using the [Form Builder]([[= user_doc =]]/creating_forms/).

![Forms](img/content_management_forms.png "Forms")

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/content_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Each Content item is an instance of a Content Type.

!!! tip

An introduction to the content model for non-developer users is available in [[[= product_name =]] user documentation](https://doc.ezplatform.com/projects/userguide/en/latest/content_model/).
An introduction to the content model for non-developer users is available in [[[= product_name =]] user documentation]([[= user_doc =]]/content_model/).

## Content items

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/internationalization.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

### Adding available languages

The multilanguage system operates based on a global translation list that contains all languages available in the installation. Languages can be [added to this list from the Admin Panel](https://doc.ibexa.co/projects/userguide/en/latest/translating_content/) in the Back Office. After adding a language be sure to dump all assets to the file system:
The multilanguage system operates based on a global translation list that contains all languages available in the installation. Languages can be [added to this list from the Admin Panel]([[= user_doc =]]/translating_content/) in the Back Office. After adding a language be sure to dump all assets to the file system:

Check warning on line 22 in docs/guide/internationalization.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/guide/internationalization.md#L22

[Ibexa.DontCapitalize] Don't capitalize 'Back Office' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Back Office' if inside the sentence.", "location": {"path": "docs/guide/internationalization.md", "range": {"start": {"line": 22, "column": 234}}}, "severity": "WARNING"}

```
yarn encore <environment>
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/multisite/site_factory_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
user_group_skeleton_remote_ids: [ <id_skeleton3>, <id_skeleton4>, ... ]
```

Manage the permissions associated to the User Group skeleton by [assigning Roles](https://doc.ibexa.co/projects/userguide/en/latest/site_organization/organizing_the_site/#managing-permissions).
Manage the permissions associated to the User Group skeleton by [assigning Roles]([[= user_doc =]]/site_organization/organizing_the_site/#managing-permissions).

Check warning on line 91 in docs/guide/multisite/site_factory_configuration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/guide/multisite/site_factory_configuration.md#L91

[Ibexa.DontCapitalize] Don't capitalize 'User Group' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'User Group' if inside the sentence.", "location": {"path": "docs/guide/multisite/site_factory_configuration.md", "range": {"start": {"line": 91, "column": 42}}}, "severity": "WARNING"}

Check warning on line 91 in docs/guide/multisite/site_factory_configuration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/guide/multisite/site_factory_configuration.md#L91

[Ibexa.DontCapitalize] Don't capitalize 'Roles' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Roles' if inside the sentence.", "location": {"path": "docs/guide/multisite/site_factory_configuration.md", "range": {"start": {"line": 91, "column": 76}}}, "severity": "WARNING"}
Make sure that the Roles that you assign to the User Group skeleton do not contain Location-based Limitations.
User Group skeletons cannot contain individual User Content items either.

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/page/create_custom_page_block.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,4 @@ The following UDW configuration is used so only an `event` typed content item ca
For more information, see [UDW configuration](extending_udw.md#udw-configuration).

Your custom page block is now ready.
Before you can use it in Page Builder, you must [enable it in Page field settings]([[= user_doc =]]/content_management/configure_ct_field_settings/#block-display).
Before you can use it in Page Builder, you must [enable it in Page field settings]([[= user_doc_4_6 =]]/content_management/configure_ct_field_settings/#block-display).
4 changes: 2 additions & 2 deletions docs/guide/personalization/basic_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ curl_close($curl);

Triggers are push messages with recommendations.
With this feature, your organization can invite individual visitors to return to the website or remind them of items abandoned in a cart by delivering a message, for example, by sending emails.
Before you can start [using triggers]([[= user_doc =]]/personalization/triggers), you must contact [[= product_name_base =]] and define specific conditions, for example:
Before you can start [using triggers]([[= user_doc_4_6 =]]/personalization/triggers/), you must contact [[= product_name_base =]] and define specific conditions, for example:

- the time that must pass before messages start being sent
- Content Types and attributes that are included in a response
Expand Down Expand Up @@ -216,6 +216,6 @@ You can configure integration at a more advanced level to track more events,
use additional parameters, apply custom scenario configurations, apply filters,
and enable additional features.

For more information about available functionalities, see the [User Documentation]([[= user_doc =]]/personalization/personalization).
For more information about available functionalities, see the [User Documentation]([[= user_doc =]]/personalization/personalization/).

For more information about integrating the Personalization service, see [Developer guide](developer_guide/tracking_api.md) and [Best practices](best_practices/tracking_integration.md).
4 changes: 2 additions & 2 deletions docs/guide/personalization/developer_guide/content_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Personalization server can use external information about the items

# Content API

Apart from the [events]([[= user_doc =]]/personalization/event_types)
Apart from the [events]([[= user_doc =]]/personalization/event_types/)
collected by the recommendation client, the recommendation engine can use external information
about the products.
This information must be uploaded to the recommendation engine by the administrator of the website.
Expand Down Expand Up @@ -58,7 +58,7 @@ The following call attributes are available:

| Parameter name | Description | Value |
|---|---|---|
| `customerid` | Your customer ID, as defined when [enabling Personalization](../enabling_personalization.md#configuring-customer-credentials) (for example, "00000"). | alphanumeric |
| `customerid` | Your customer ID, as defined when [enabling Personalization](enabling_personalization.md#setting-up-customer-credentials) (for example, "00000"). | alphanumeric |
| `itemid` | A unique ID of the Content item/product. Used to identify the item in the database. | integer |
| `itemtypeid` | An ID of the type of Content item/product. In most cases, the value is 1 but you might have items/products of more than one type. | integer |
| `lang` | A [language code](../../internationalization.md) of the Content item/product (for example, "ger-DE"). This parameter is optional. | string |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

|Parameter|Description|Value|
|---|---|---|
|`customerid`|Your customer ID, as defined when [enabling Personalization](../enabling_personalization.md#configuring-customer-credentials) (for example, "00000").|alphanumeric|
|`customerid`|Your customer ID, as defined when [enabling Personalization](enabling_personalization.md#setting-up-customer-credentials) (for example, "00000").|alphanumeric|
|`userid`|An ID of the tracked user in the website (for example, an internal customer code, a session code or a cookie for anonymous users.|alphanumeric|
|`scenarioid`|An ID of the scenario used for providing recommendations, as defined in the Back Office.|alphanumeric|
|`extension`|A format of the response (either JSON or JSONP).|`json` or `jsonp`|
Expand All @@ -53,7 +53,7 @@
|Parameter|Example|Description|Value|
|---|---|---|---|
|`numrecs`|20|Defines a number of recommendations to be delivered. The lower this value, the shorter the response time. The default value is 10. |1 to 50|
|`contextitems`|10,13,14 or "CLICKED"|A comma-separated list of items that the user is viewing on the web page. The list is required by [context-based recommendations]([[= user_doc =]]/personalization/recommendation_models). All items must be of the same type. The type is defined in the scenario configuration. If history code is used ("CLICKED","CONSUMED", "OWNS", "RATED" or "BASKET"), context items are pulled from the user profile (for example, the most recent clicks or purchases). This parameter is optional. |1 to 2147483647 (or alphanumeric if enabled)|
|`contextitems`|10,13,14 or "CLICKED"|A comma-separated list of items that the user is viewing on the web page. The list is required by [context-based recommendations]([[= user_doc =]]/personalization/recommendation_models/). All items must be of the same type. The type is defined in the scenario configuration. If history code is used ("CLICKED","CONSUMED", "OWNS", "RATED" or "BASKET"), context items are pulled from the user profile (for example, the most recent clicks or purchases). This parameter is optional. |1 to 2147483647 (or alphanumeric if enabled)|

Check warning on line 56 in docs/guide/personalization/developer_guide/recommendation_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/guide/personalization/developer_guide/recommendation_api.md#L56

[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.
Raw output
{"message": "[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.", "location": {"path": "docs/guide/personalization/developer_guide/recommendation_api.md", "range": {"start": {"line": 56, "column": 17}}}, "severity": "WARNING"}
|`outputtypeid`|1|Required for scenarios that are defined with multiple output item types, otherwise optional. By default it is the first/lowest output type enabled in the scenario config.|numeric|
|`jsonpCallback`|"myCallback"|Function or method name (used for JSONP request only). It can be a function ("callme"), or a method ("obj.callme"). The default value is "jsonpCallback".|legal JavaScript function call|
|`attribute`|"title" or "description"|If you apply this parameter, the engine tries to fetch the value of the attribute. For example, `&attribute=title` means fetching the title for the item that is delivered in the response, if available. The fetch works if content import has been successful. You can pass multiple attributes: `&attribute=title&attribute=description` or `&attribute=title,description`. Use this to pull "pure" client-based recommendations without requesting local customer data.|string|
Expand Down Expand Up @@ -99,7 +99,7 @@
|---|---|---|---|
|`segments`|`&segments=7,8,10,11`|ID from segment group management|string|

For more information, see [Segments]([[= user_doc =]]/personalization/segment_management).
For more information, see [Segments]([[= user_doc_4_6 =]]/personalization/segment_management/).

## Responses

Expand All @@ -111,7 +111,7 @@
!!! note "Previewing recommendations"

You can preview the actual responses that come from the recommendation engine and how they are rendered in the user interface.
For more information, see [Scenarios]([[= user_doc =]]/personalization/scenarios/#previewing-scenario-results).
For more information, see [Scenarios]([[= user_doc =]]/personalization/previewing_scenario/).

For more information about integrating recommendations in the web page, see [Best practices](../best_practices/recommendation_integration.md).

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/personalization/developer_guide/tracking_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The most popular user events are:
- Login - When a user logs in on a website
- Clickrecommended - When a user clicks a recommendation

For a complete list of events, see [Event types]([[= user_doc =]]/personalization/event_types) in the user documentation.
For a complete list of events, see [Event types]([[= user_doc =]]/personalization/event_types/) in the user documentation.
Depending on the event type, some additional parameters, such as item price
or user rating, must be provided.

Expand Down Expand Up @@ -171,7 +171,7 @@ For a list of embedded parameters that each of the events may use, see the follo

|Name|Description|Values|
|---|---|---|
|`customerid`|A customer ID (for example "00000"). Can be used to identify a website in installations that [hosts multiple SiteAccesses]([[= user_doc =]]/personalization/use_cases/#multiple-website-hosting).|alphanumeric|
|`customerid`|A customer ID (for example "00000"). Can be used to identify a website in installations that [hosts multiple SiteAccesses]([[= user_doc_4_6 =]]/personalization/use_cases/#multiple-website-hosting).|alphanumeric|
|userid|A user's ID on the website of the customer. It could be an internal customer code, a session code or a cookie for anonymous users.|URL-encoded alphanumeric|
|`itemtypeid`|Item type ID.|1 to 2147483647|
|`itemid`|A unique ID of the item the user has clicked.</br>String-based identifiers are also supported as item IDs to track content on a website, but it is discouraged due to fraud and security issues. If you are unable to provide numeric identifiers for the tracking process, contact Ibexa for further information and implementation notes.|1 to 2147483647|
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/personalization/enabling_personalization.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,5 @@
## Configuring recommendation logic

Once you enable the recommendation client, you can go back to the Back Office,
refresh the Personalization dashboard and proceed with [configuring the logic]([[= user_doc =]]/personalization/perso_configuration) used to calculate
refresh the Personalization dashboard and proceed with [configuring the logic]([[= user_doc =]]/personalization/perso_configuration/) used to calculate

Check warning on line 35 in docs/guide/personalization/enabling_personalization.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/guide/personalization/enabling_personalization.md#L35

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/guide/personalization/enabling_personalization.md", "range": {"start": {"line": 35, "column": 152}}}, "severity": "WARNING"}
the recommendation results.
2 changes: 1 addition & 1 deletion docs/guide/personalization/personalization.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ The idea behind the Personalization service is built upon four main steps.

![Overview of how recommendation works](img/recommendation_overview.png)

For more information about available functionalities, see [User Documentation]([[= user_doc =]]/personalization/personalization).
For more information about available functionalities, see [User Documentation]([[= user_doc =]]/personalization/personalization/).

For more information about enabling the Personalization service, see [Enabling Personalization](enabling_personalization.md).
5 changes: 3 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -703,8 +703,9 @@ extra:
latest_tag_4_5: '4.5.7'
latest_tag_4_6: '4.6.16'

symfony_doc: 'http://symfony.com/doc/5.4'
user_doc: 'https://doc.ibexa.co/projects/userguide/en/master'
symfony_doc: 'https://symfony.com/doc/5.x'
user_doc: 'https://doc.ibexa.co/projects/userguide/en/3.3'
user_doc_4_6: 'https://doc.ibexa.co/projects/userguide/en/4.6'

extra_css:
- fonts/MavenPro.css
Expand Down
Loading