Skip to content

Commit ba54ca5

Browse files
Described existing LTS updates as built-in into product (#2752)
* Described existing LTS updates as built-in into product * Rebuild * Fixed menu entry * Added list of previous LTS updates * Update docs/ibexa_products/editions.md * Apply suggestions from code review Co-authored-by: julitafalcondusza <[email protected]> --------- Co-authored-by: julitafalcondusza <[email protected]>
1 parent 62ee0ea commit ba54ca5

File tree

12 files changed

+46
-165
lines changed

12 files changed

+46
-165
lines changed

docs/ai_actions/ai_actions.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
---
22
description: AI Actions help editors by automating repetitive tasks.
33
page_type: landing_page
4-
edition: lts-update
54
month_change: false
65
---
76

87
# AI Actions
98

10-
The AI Actions LTS update enhances the usability and flexibility of [[= product_name =]] by automating various tasks.
9+
AI Actions enhance the usability and flexibility of [[= product_name =]] by automating various tasks.
1110
After you configure it, it can generate alt text for images or transform text passages.
1211

1312
You can also extend it to perform other tasks or support additional AI services.
1413

1514
[[= cards([
1615
"ai_actions/ai_actions_guide",
17-
"ai_actions/install_ai_actions",
16+
"ai_actions/configure_ai_actions",
1817
"ai_actions/extend_ai_actions",
1918
], columns=4) =]]

docs/ai_actions/ai_actions_guide.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
2-
description: AI Actions LTS update helps editors by automating repetitive tasks.
3-
edition: lts-update
2+
description: AI Actions help editors by automating repetitive tasks.
43
month_change: true
54
---
65

@@ -9,12 +8,12 @@ month_change: true
98
## What are AI Actions
109

1110
Wherever you look, artificial intelligence becomes more and more important by enhancing user interaction and automating complex processes.
12-
[[= product_name =]] can be equipped with the AI Actions [LTS update](editions.md#lts-updates), which harnesses AI's potential to automate time-consuming editorial tasks.
11+
[[= product_name =]] is equipped with the AI Actions feature, which harnesses AI's potential to automate time-consuming editorial tasks.
1312
AI Actions is an extensible solution for integrating features provided by AI services into your workflows, all managed through a user-friendly interface.
1413

1514
Out-of-the-box, AI Actions solution includes two essential components: a framework package and an OpenAI connector package.
1615

17-
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.
16+
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.
1817
From the developer's perspective, the integration removes the burden of maintaining third-party AI handlers, and accelerates the deployment of AI-based solutions.
1918

2019
AI Actions solution comes pre-configured with the following action types:
@@ -30,15 +29,14 @@ The possibilities are endless and you're not limited to a specific AI service, a
3029

3130
## Availability
3231

33-
AI Actions are an opt-in capability available as an [LTS update](editions.md#lts-updates) starting with the v4.6.12 version of [[= product_name =]], regardless of its edition.
34-
[[= product_name_connect =]] integration is available starting with v4.6.19.
35-
To begin using AI Actions, you must first [install the required packages and perform initial configuration](install_ai_actions.md).
32+
[[= product_name_cloud =]] is available in all [[= product_name =]] editions.
33+
To begin using AI Actions, you must first [perform the initial configuration](configure_ai_actions.md).
3634

3735
### Prerequisites
3836

3937
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).
4038

41-
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#create-token).
39+
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](configure_ai_actions.md#create-token).
4240

4341
!!! note "[[= product_name_connect =]] Availability"
4442

@@ -47,7 +45,7 @@ Integration with [[= product_name_connect =]] requires that you first [get the c
4745

4846
## How it works
4947

50-
AI Actions LTS update relies on an extensible AI framework, which is responsible for gathering information from various sources, such as AI action types, AI action configurations, and contextual details like SiteAccess, user details, locale settings, and more.
48+
AI Actions rely on an extensible AI framework, which is responsible for gathering information from various sources, such as AI action types, AI action configurations, and contextual details like SiteAccess, user details, locale settings, and more.
5149
This data can then be combined with user input.
5250
It's then passed to a service connector, such as the default OpenAI connector or the [[= product_name_connect =]] connector, for final processing on [[= product_name =]] side.
5351
The service connector wraps all data into a prompt or another suitable format and sends it to an external service.
@@ -101,7 +99,7 @@ Handlers take parameters defined in the AI action type and configuration, combin
10199

102100
### Triggering actions from the UI
103101

104-
Among other elements, AI Actions LTS update includes UI components that are used in:
102+
Among other elements, AI Actions include UI components that are used in:
105103

106104
- AI action management in the **Admin** panel
107105
- text modification in online editor
@@ -113,7 +111,7 @@ Procedures are straightforward and intuitive, ensuring that users can quickly ac
113111

114112
### Triggering actions programmatically
115113

116-
AI Actions LTS update exposes a REST API interface that allows for programmatic execution of AI actions.
114+
AI Actions feature exposes a REST API interface that allows for programmatic execution of AI actions.
117115
With the API, developers can automate tasks and execute actions on batches of content by integrating them into workflows.
118116
For more information, see the [AI actions section in the REST API Reference](../api/rest_api/rest_api_reference/rest_api_reference.html#ai-actions-execute-ai-action).
119117

@@ -132,15 +130,15 @@ By accessing the detailed view of individual AI actions, you can quickly review
132130

133131
### Extensibility
134132

135-
Built-in AI action types offer a good starting point, but the real power of the AI Actions LTS update lies in extensibility.
133+
Built-in AI action types offer a good starting point, but the real power of AI Actions lies in extensibility.
136134
Extending AI Actions opens up new possibilities for content management and editing.
137135
Developers can define new models and AI action types that use the existing AI service or even integrate additional services.
138136
The latter involves developing a new service connector, writing a handler that communicates with the new service, defining a new AI action type, and creating a form for configuring options, which extends the default action configuration form shown in the **Admin** panel.
139137
For example, if this is your organization's requirement, a developer could write a handler that uses an AI service available internally, without exposing your data to a third-party service.
140138

141139
## Use cases
142140

143-
Out of the box, after you configure access to the OpenAI service, the [[= product_name_base =]] AI Actions LTS update comes with two action types that can help your organization with the following tasks.
141+
Out of the box, after you configure access to the OpenAI service, the [[= product_name_base =]] AI Actions come with two action types that can help your organization with the following tasks.
144142

145143
### Refining text
146144

docs/ai_actions/install_ai_actions.md renamed to docs/ai_actions/configure_ai_actions.md

Lines changed: 10 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,22 @@
11
---
2-
description: Install the AI Actions LTS update.
3-
edition: lts-update
2+
description: Configure AI Actions.
43
month_change: true
54
---
65

7-
# Install AI Actions
6+
# Configure AI Actions
87

9-
AI Actions are available as an LTS update to [[= product_name =]] starting with version v4.6.12 or higher, regardless of its edition.
10-
To use this feature you must first install the package.
11-
You can then install and configure the service connectors or build your own ones.
12-
13-
## Install framework
14-
15-
Run the following command to install the package:
16-
17-
``` bash
18-
composer require ibexa/connector-ai
19-
```
20-
21-
This command adds the framework code, service handlers, Twig templates, and configurations required for using AI Actions.
22-
It also modifies the permission system to account for the new functionality.
23-
24-
## Modify database schema
25-
26-
Create the `add_ai_actions.sql` file that contains the following code.
27-
28-
=== "MySQL"
29-
30-
``` sql
31-
[[= include_file('code_samples/ai_actions/config/mysql/add_ai_actions.sql', 0, None, ' ') =]]
32-
```
33-
34-
=== "PostgreSQL"
35-
36-
``` sql
37-
[[= include_file('code_samples/ai_actions/config/postgresql/add_ai_actions.sql', 0, None, ' ') =]]
38-
```
39-
40-
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).
41-
42-
=== "MySQL"
43-
44-
```bash
45-
mysql -u <username> -p <password> <database_name> < add_ai_actions.sql
46-
```
47-
48-
=== "PostgreSQL"
49-
50-
```bash
51-
psql <database_name> < add_ai_actions.sql
52-
```
53-
54-
This command modifies the existing database schema by adding database configuration required for using AI Actions.
8+
AI Actions are available in [[= product_name =]] regardless of its edition.
9+
To use this feature you must first configure the built-in service connectors or build your own ones.
5510

5611
!!! note "Next steps"
5712

58-
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).
13+
Once the framework is 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).
5914

6015
Only then you can restart you application and start [working with the AI Actions feature]([[= user_doc =]]/ai_actions/work_with_ai_actions/).
6116

62-
## Configure access to OpenAI
17+
## Configure access to OpenAI (optional)
6318

64-
Run the following command to install the service connector with the OpenAI service:
65-
66-
``` bash
67-
composer require ibexa/connector-openai
68-
```
69-
70-
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).
19+
To use the built-in connector with the OpenAI service, you need to 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).
7120

7221
Then, in the root folder of your project, modify the `.env` file: find the `OPENAI_API_KEY` variable and replace a placeholder value with the API key that you got from the AI service.
7322

@@ -77,15 +26,9 @@ OPENAI_API_KEY=<your_api_key>
7726
###< ibexa/connector-openai ###
7827
```
7928

80-
### Install sample OpenAI action configurations (optional)
81-
82-
By installing a collection of sample AI action configurations you can quickly start using the feature.
83-
You do it by following a standard [data migration](importing_data.md) procedure:
29+
### Sample OpenAI action configurations
8430

85-
```bash
86-
php bin/console ibexa:migrations:import vendor/ibexa/connector-openai/src/bundle/Resources/migrations/action_configurations.yaml
87-
php bin/console ibexa:migrations:migrate
88-
```
31+
The AI actions come with sample AI action configurations to quickly get you started on using the feature.
8932

9033
Based on these examples, which reflect the most common use cases, you can learn to configure your own AI actions with greater ease.
9134

@@ -161,7 +104,7 @@ php bin/console ibexa:connect:init-connect-ai 2 en connect-image-to-text connect
161104

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

164-
### Customize templates
107+
### Customize templates
165108

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

docs/ai_actions/extend_ai_actions.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
description: Extend AI Actions by connecting to other services and adding new capabilities.
3-
edition: lts-update
43
month_change: false
54
---
65

docs/content_management/data_migration/importing_data.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -346,9 +346,9 @@ You can also update attributes, including changing which attribute group they be
346346

347347
You can't change the attribute type of an existing attribute.
348348

349-
##### Date and time attributes [[% include 'snippets/lts-update_badge.md' %]]
349+
##### Date and time attributes
350350

351-
If you're using attributes of the [date and time type](date_and_time.md), you can manage it through the migrations as well, for example:
351+
You can manage the [date and time attribute type](date_and_time.md) through the migrations, for example:
352352

353353
``` yaml
354354
[[= include_file('code_samples/data_migration/examples/create_datetime_attribute.yaml') =]]
@@ -487,7 +487,7 @@ When updating a content type, use:
487487
[[= include_file('code_samples/data_migration/examples/update_tag.yaml') =]]
488488
```
489489

490-
### AI action configurations [[% include 'snippets/lts-update_badge.md' %]]
490+
### AI action configurations
491491

492492
- The following example shows how you can create a new action configuration in your system:
493493

docs/ibexa_products/editions.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Compare all features available in [[= product_name_headless =]], [[= product_nam
2020
| Feature | [[= product_name_headless =]] | [[= product_name_exp =]] | [[= product_name_com =]] |
2121
|-----------------|-----------------|-----------------|-----------------|
2222
| [Content model](content_model.md) | &#10004; | &#10004; | &#10004; |
23+
| [AI Actions](ai_actions_guide.md) | &#10004; | &#10004; | &#10004; |
2324
| [User management](user_management_guide.md) | &#10004; | &#10004; | &#10004; |
2425
| [Focus Mode]([[= user_doc =]]/getting_started/discover_ui/#focus-mode) | &#10004; | &#10004; | &#10004; |
2526
| [Image editor]([[= user_doc =]]/image_management/edit_images/) | &#10004; | &#10004; | &#10004; |
@@ -30,6 +31,7 @@ Compare all features available in [[= product_name_headless =]], [[= product_nam
3031
| [Editorial workflow]([[= user_doc =]]/content_management/workflow_management/editorial_workflow/) | &#10004; | &#10004; | &#10004; |
3132
| [Digital Asset Management]([[= user_doc =]]/dam/ibexa_dam/) | &#10004; | &#10004; | &#10004; |
3233
| [Product Information Management]([[= user_doc =]]/pim/pim/) | &#10004; | &#10004; | &#10004; |
34+
| [Date and time attribute type](date_and_time.md) | &#10004; | &#10004; | &#10004; |
3335
| [Personalization](personalization_guide.md) | &#10004; | &#10004; | &#10004; |
3436
| [Migrations](managing_migrations.md) | &#10004; | &#10004; | &#10004; |
3537
| [[[= product_name_connect =]]]([[= connect_doc =]]) | &#10004; | &#10004; | &#10004; |
@@ -60,7 +62,12 @@ Compare all features available in [[= product_name_headless =]], [[= product_nam
6062
LTS Updates are opt-in packages that bring additional features to the [LTS releases](release_process_and_roadmap.md#long-term-support-releases) that they enhance.
6163
The features brought by LTS Updates become standard parts of the next LTS release.
6264

63-
| Feature | [[= product_name_headless =]] | [[= product_name_exp =]] | [[= product_name_com =]] |
64-
|-----------------|-----------------|-----------------|-----------------|
65-
| [AI Actions](ai_actions_guide.md) | &#10004; | &#10004; | &#10004; |
66-
| [Date and time attribute type](date_and_time.md) | &#10004; | &#10004; | &#10004; |
65+
There aren't any LTS Updates available for the v5 release yet.
66+
The ones released for 4.6 LTS are included out of the box in [[= product_name =]] 5.0 LTS:
67+
68+
- [AI Actions](ai_actions_guide.md)
69+
- [Date and time attribute type](date_and_time.md)
70+
71+
72+
<!-- | Feature | [[= product_name_headless =]] | [[= product_name_exp =]] | [[= product_name_com =]] |
73+
|-----------------|-----------------|-----------------|-----------------| -->

docs/index.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,11 @@
7272
</div>
7373
</div>
7474
<div class="row notifications">
75-
<div class="col-12 col-lg-6">
75+
<div class="col-12 col-lg-12">
7676
<div class="notification notification--latest-release" id="tile2">
7777
<div class="notification__content">
78-
<h2>The latest release is [[= latest_tag_4_6 =]]</h2>
79-
<div>The latest version of Ibexa DXP is [[= latest_tag_4_6 =]]. You can now update your application to the latest version.</div>
78+
<h2>The latest release is [[= latest_tag_5_0 =]]</h2>
79+
<div>The latest version of Ibexa DXP is [[= latest_tag_5_0 =]]. You can now update your application to the latest version.</div>
8080
</div>
8181
<div class="notification__cta">
8282
<a href="release_notes/ibexa_dxp_v4.6/">Release notes</a>
@@ -86,21 +86,6 @@
8686
</div>
8787
</div>
8888
</div>
89-
<div class="col-12 col-lg-6">
90-
<div class="notification notification--lts-update" id="tile3">
91-
<div class="notification__content">
92-
<h2>The newest LTS Update is the Date and time attribute type</h2>
93-
<div>Install it to add time-related values to product specifications.</div>
94-
</div>
95-
<div class="notification__cta">
96-
<a href="pim/attributes/date_and_time">Learn more about this LTS Update</a>
97-
<a href="ibexa_products/editions#lts-updates">Discover other LTS Updates</a>
98-
</div>
99-
<div class="notification__image">
100-
<img src="images/notification-lts-update.svg" alt="LTS Update" />
101-
</div>
102-
</div>
103-
</div>
10489
</div>
10590
<div class="row">
10691
<div class="col-12">

0 commit comments

Comments
 (0)