Implement changes from review

dabrt · dabrt · commit f4c6a2954f1d · 2025-04-09T14:41:11.000+02:00
diff --git a/docs/administration/project_organization/bundles.md b/docs/administration/project_organization/bundles.md
@@ -71,7 +71,7 @@ To remove a bundle (either one you created yourself, or an out-of-the-box one th
 |---------|-----------|
 |ibexa/oss|Core packages|
 |ibexa/content-tree|content tree functionality|
-|ibexa/connect|[[[= product_name_connect =]]](https://doc.ibexa.co/projects/connect/en/latest/)|
+|ibexa/connect|[[[= product_name_connect =]]]([[= connect_doc =]]/)|
 |ibexa/calendar|Calendar tab with a calendar widget|
 |ibexa/connector-dam|Connector for DAM (Digital Asset Management) systems|
 |ibexa/elasticsearch|Integration with Elasticsearch search engine|
diff --git a/docs/ai_actions/ai_actions_guide.md b/docs/ai_actions/ai_actions_guide.md
@@ -13,7 +13,7 @@ AI Actions is an extensible solution for integrating features provided by AI ser
 
 Out-of-the-box, AI Actions solution includes two essential components: a framework package and an OpenAI connector package.
 
-As of version v4.6.19, AI Actions can integrate with [[[= product_name_connect =]]](https://doc.ibexa.co/projects/connect/en/latest/general/ibexa_connect/), to give you an opportunity to build complex data transformation workflows without having to rely on custom code.
+As of version v4.6.19, AI Actions can integrate with [[[= product_name_connect =]]]([[= connect_doc =]]/general/ibexa_connect/), to give you an opportunity to build complex data transformation workflows without having to rely on custom code.
 From the developer's perspective, the integration removes the burden of maintaining third-party AI handlers, and accelerates the deployment of AI-based solutions.
 
 AI Actions solution comes pre-configured with the following action types:
@@ -37,7 +37,7 @@ To begin using AI Actions, you must first [install the required packages and per
 
 The OpenAI connector requires that you first [get an API key](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key) and make sure that you [set up a billing method](https://help.openai.com/en/articles/9038407-how-can-i-set-up-billing-for-my-account).
 
-Integration with [[= product_name_connect =]] requires that you first [get the credentials](https://doc.ibexa.co/projects/connect/en/latest/general/ibexa_connect/#access-ibexa-connect) to your account, and the [API token](install_ai_actions.md#token).
+Integration with [[= product_name_connect =]] requires that you first [get the credentials]([[= connect_doc =]]/general/ibexa_connect/#access-ibexa-connect) to your account, and the [API token](install_ai_actions.md#token).
 
 !!! note "[[= product_name_connect =]] Availability"
 
diff --git a/docs/ai_actions/install_ai_actions.md b/docs/ai_actions/install_ai_actions.md
@@ -6,25 +6,63 @@ month_change: false
 # Install AI Actions
 
 AI Actions are available as an LTS update to [[= product_name =]] starting with version v4.6.12 or higher, regardless of its edition.
-To use this feature you must first install the packages and configure them.
+To use this feature you must first install the package.
+You can then install and configure the service connectors or build your onw ones.
 
-## Install packages
-
-Run the following commands to install the packages:
+Run the following command to install the package:
 
 ``` bash
 composer require ibexa/connector-ai
-composer require ibexa/connector-openai
 ```
 
-This command adds the framework code, a service connector with the OpenAI service, service handlers, Twig templates, and configurations required for using AI Actions.
+This command adds the framework code, service handlers, Twig templates, and configurations required for using AI Actions.
 It also modifies the permission system to account for the new functionality.
 
-## Configure AI Actions
+## Modify the database schema
+
+Create the `add_ai_actions.sql` file that contains the following code.
+
+=== "MySQL"
+
+    ``` sql
+    [[= include_file('code_samples/ai_actions/config/mysql/add_ai_actions.sql', 0, None, '    ') =]]
+    ```
+
+=== "PostgreSQL"
+
+    ``` sql
+    [[= include_file('code_samples/ai_actions/config/postgresql/add_ai_actions.sql', 0, None, '    ') =]]
+    ```
+
+Run the following command, where `<database_name>` is the same name that you defined when you [installed [[= product_name =]]](../getting_started/install_ibexa_dxp.md#change-installation-parameters).
+
+=== "MySQL"
 
-Once the packages are installed, before you can start using AI Actions, you must enable them by following these instructions.
+    ```bash
+    mysql -u <username> -p <password> <database_name> < add_ai_actions.sql
+    ```
 
-### Configure access to OpenAI
+=== "PostgreSQL"
+
+    ```bash
+    psql <database_name> < add_ai_actions.sql
+    ```
+
+This command modifies the existing database schema by adding database configuration required for using AI Actions.
+
+!! note "Next steps"
+
+    Once the framework is installed and configured, before you can start using AI Actions, you can configure access to [[ = product_name_base = ]]-made service connectors by following the instructions below, or [create your own](extend_ai_actions.md#create-custom-action-handler).
+
+    Only then you can restart you application and start [working with the AI Actions feature]([[= user_doc =]]/ai_actions/work_with_ai_actions/).
+
+## Configure access to OpenAI
+
+Run the following command to install the service connector with the OpenAI service:
+
+``` bash
+composer require ibexa/connector-openai
+```
 
 Create an OpenAI account, [get an API key](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key), and make sure that you [set up a billing method](https://help.openai.com/en/articles/9038407-how-can-i-set-up-billing-for-my-account).
 
@@ -36,28 +74,40 @@ OPENAI_API_KEY=<your_api_key>
 ###< ibexa/connector-openai ###
 ```
 
-### Configure access to [[= product_name_connect =]]
+### Install sample OpenAI action configurations (optional)
+
+By installing a collection of sample AI action configurations you can quickly start using the feature.
+You do it by following a standard [data migration](importing_data.md) procedure:
+
+```bash
+php bin/console ibexa:migrations:import vendor/ibexa/connector-openai/src/bundle/Resources/migrations/action_configurations.yaml
+php bin/console ibexa:migrations:migrate
+```
+
+Based on these examples, which reflect the most common use cases, you can learn to configure your own AI actions with greater ease.
+
+## Configure access to [[= product_name_connect =]]
 
 First, get the credentials by contacting [Ibexa Support](https://support.ibexa.co).
 
-#### Create team
+### Create team
 
-In [[= product_name_connect =]], set up the account, and [create a team](https://doc.ibexa.co/projects/connect/en/latest/access_management/teams/#creating-teams).
+In [[= product_name_connect =]], set up the account, and [create a team]([[= connect_doc =]]/access_management/teams/#creating-teams).
 Navigate to the team details page and note down the numerical value of the **Team id** variable.
 
-Creating a team matters, because [scenarios](https://doc.ibexa.co/projects/connect/en/latest/scenarios/creating_a_scenario/) that process data coming from your AI action are associated with a team.
-This way, if your organization has more than one application, each application can be linked to a different team and so can be scenarios coming from those applications.
+Creating a team matters, because [scenarios]([[= connect_doc =]]/scenarios/creating_a_scenario/) that process data coming from your AI action are associated with a team.
+This way, if your organization has more than one [[= product_name =]] project, each project can be linked to a different team and so can be scenarios used in those projects.
 
-If specific users from the team are supposed to modify scenario settings, you must [assign the right roles](https://doc.ibexa.co/projects/connect/en/latest/access_management/teams/#managing-teams) to them.
+If specific users from the team are supposed to modify scenario settings, you must [assign the right roles]([[= connect_doc =]]/access_management/teams/#managing-teams) to them.
 
-#### Create token
+### Create token
 
 Navigate to your [[= product_name_connect =]] user's profile, and on the **API ACCESS** tab, create a new token.
 Copy the token code that appears next to the label.
 
 ![Creating an API token](img/connect_api_token.png)
 
-#### Set up credentials
+### Set up credentials
 
 In the root folder of your project, modify the `.env` file.
 Replace a placeholder value of the `IBEXA_CONNECT_TOKEN` variable with the token that you got from [[= product_name_connect =]] and provide a value of the `IBEXA_CONNECT_TEAM_ID` variable.
@@ -74,12 +124,12 @@ IBEXA_CONNECT_TEAM_ID=2
 ###< ibexa/connect ###
 ```
 
-#### Initiate integration
+### Initiate integration
 
 Initiate the models provided by the handler by issuing the following command:
 
 ```bash
-php bin/console ibexa:connect:init-connect-ai <team_id> <language> <model list>
+php bin/console ibexa:connect:init-connect-ai <team_id> <language> <action handler identifiers>
 ```
 
 For example:
@@ -92,54 +142,8 @@ php bin/console ibexa:connect:init-connect-ai 2 en connect-image-to-text connect
 
     The [`language` attribute](https://developers.make.com/api-documentation/api-reference/templates#templates-1) determines the language in which template details such as module names will be displayed in [[= product_name_connect =]]'s UI.
 
-#### Customize templates 
+### Customize templates 
 
-Return to the [[= product_name_connect =]] dashboard and modify the **Template for connect...handler** [templates](https://doc.ibexa.co/projects/connect/en/latest/scenarios/scenario_templates/) by defining the logic needed to process the data.
+Return to the [[= product_name_connect =]] dashboard and modify the **Template for connect...handler** [templates]([[= connect_doc =]]/scenarios/scenario_templates/) by defining the logic needed to process the data.
 
 Once the templates are ready, you can build scenarios from them, either directly in [[= product_name_connect =]] or in [[[= product_name =]]'s user interface]([[= user_doc =]]/ai_actions/work_with_ai_actions/#create-new-ai-actions).
-
-### Modify the database schema
-
-Create the `add_ai_actions.sql` file that contains the following code.
-
-=== "MySQL"
-
-    ``` sql
-    [[= include_file('code_samples/ai_actions/config/mysql/add_ai_actions.sql', 0, None, '    ') =]]
-    ```
-
-=== "PostgreSQL"
-
-    ``` sql
-    [[= include_file('code_samples/ai_actions/config/postgresql/add_ai_actions.sql', 0, None, '    ') =]]
-    ```
-
-Run the following command, where `<database_name>` is the same name that you defined when you [installed [[= product_name =]]](../getting_started/install_ibexa_dxp.md#change-installation-parameters).
-
-=== "MySQL"
-
-    ```bash
-    mysql -u <username> -p <password> <database_name> < add_ai_actions.sql
-    ```
-
-=== "PostgreSQL"
-
-    ```bash
-    psql <database_name> < add_ai_actions.sql
-    ```
-
-This command modifies the existing database schema by adding database configuration required for using AI Actions.
-
-You can now restart you application and start [working with the AI Actions feature]([[= user_doc =]]/ai_actions/work_with_ai_actions/).
-
-### Install sample AI action configurations (optional)
-
-By installing a collection of sample AI action configurations you can quickly start using the feature.
-You do it by following a standard [data migration](importing_data.md) procedure:
-
-```bash
-php bin/console ibexa:migrations:import vendor/ibexa/connector-openai/src/bundle/Resources/migrations/action_configurations.yaml
-php bin/console ibexa:migrations:migrate
-```
-
-Based on these examples, which reflect the most common use cases, you can learn to configure your own AI actions with greater ease.
diff --git a/docs/ibexa_engage/integrate_ibexa_connect.md b/docs/ibexa_engage/integrate_ibexa_connect.md
@@ -5,11 +5,11 @@ edition: experience
 
 # Use Ibexa Connect
 
-You can use [[[= product_name_connect =]]](https://doc.ibexa.co/projects/connect/en/latest/general/ibexa_connect/) to create workflows.
+You can use [[[= product_name_connect =]]]([[= connect_doc =]]/general/ibexa_connect/) to create workflows.
 [[= product_name_engage =]] collects user data and passes it directly to [[= product_name_connect =]].
 With this data, you can create scenarios, for example, to add a user to newsletter, or to specific user segment group.
 
-For more information, see [[[= product_name_connect =]] documentation](https://doc.ibexa.co/projects/connect/en/latest/).
+For more information, see [[[= product_name_connect =]] documentation]([[= connect_doc =]]/).
 
 ## Integrate [[= product_name_engage =]] with [[= product_name_connect =]]
 
@@ -55,4 +55,4 @@ To do it, perform the following actions::
 ![Configure Ibexa Engage](configure_ibexa_engage.png "Configure Ibexa Engage")
 
 4\. Then, go to **Engage** -> **Integrations** -> **Push rules** to define the default or specific rules for new campaign or website.
-Select the created webhook.
+Select the created webhook.
diff --git a/docs/personalization/integrate_recommendation_service.md b/docs/personalization/integrate_recommendation_service.md
@@ -167,7 +167,7 @@ To let your visitors receive emails with recommendations:
 1\. With the [User API](api_reference/user_api.md#post-requests), add the `e-mail` attribute (or another identifier) to the user record.
 
 2\. Prepare an endpoint to intercept push messages and pass them on, for example, to your mailing system.
-Out of many options, it could be an [[= product_name_connect =]] [webhook](https://doc.ibexa.co/projects/connect/en/latest/tools/webhooks/).
+Out of many options, it could be an [[= product_name_connect =]] [webhook]([[= connect_doc =]]/tools/webhooks/).
 The endpoint must meet the following requirements:
 
  - must support POST requests
diff --git a/docs/release_notes/ibexa_dxp_v4.4.md b/docs/release_notes/ibexa_dxp_v4.4.md
@@ -89,7 +89,7 @@ You can now take advantage of [[[= product_name_connect =]]](https://www.ibexa.c
 an iPaaS (integration platform-as-a-service) which allows you to connect [[= product_name =]] with third-party applications.
 [[= product_name_connect =]] features a low-code drag-and-drop interface and hundreds of connectors to different services that help you automate business processes.
 
-See [[[= product_name_connect =]] documentation](https://doc.ibexa.co/projects/connect/en/latest/).
+See [[[= product_name_connect =]] documentation]([[= connect_doc =]]/).
 
 ![Example of an Ibexa Connect scenario](4.4_connect_scenario_example.png)
 
diff --git a/docs/release_notes/ibexa_dxp_v4.5.md b/docs/release_notes/ibexa_dxp_v4.5.md
@@ -211,7 +211,7 @@ For more information, see [Breached passwords](https://doc.ibexa.co/en/4.5/users
 
 ### [[= product_name_connect =]]
 
-For list of changes in [[= product_name_connect =]], see [Ibexa app release notes](https://doc.ibexa.co/projects/connect/en/latest/general/ibexa_app_release_notes/).
+For list of changes in [[= product_name_connect =]], see [Ibexa app release notes]([[= connect_doc =]]/general/ibexa_app_release_notes/).
 
 ### Deprecations
 
diff --git a/docs/release_notes/ibexa_dxp_v4.6.md b/docs/release_notes/ibexa_dxp_v4.6.md
@@ -873,7 +873,7 @@ A new helper method `ibexa.helpers.contentType.getContentTypeDataByHref` has bee
 
 #### [[= product_name_connect =]]
 
-For a list of changes in [[= product_name_connect =]], see [Ibexa app release notes](https://doc.ibexa.co/projects/connect/en/latest/general/ibexa_app_release_notes/).
+For a list of changes in [[= product_name_connect =]], see [Ibexa app release notes]([[= connect_doc =]]/general/ibexa_app_release_notes/).
 
 ##### Scenario block
 
