Skip to content

Commit 938fa1e

Browse files
committed
Add a release notes section
1 parent 5f3dde3 commit 938fa1e

File tree

7 files changed

+30
-21
lines changed

7 files changed

+30
-21
lines changed

docs/ai_actions/ai_actions.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,13 @@ page_type: landing_page
55

66
# AI Actions
77

8-
The AI Actions add-on enhances the usability and flexibility of [[= product_name =]] by automating various tasks.
8+
The AI Actions LTS update enhances the usability and flexibility of [[= product_name =]] by automating various tasks.
99
After you configure it, it can generate alt text for images or transform text passages.
1010

11-
You can also extend it to perform other tasks or support additional AI engines.
11+
You can also extend it to perform other tasks or support additional AI services.
1212

1313
[[= cards([
1414
"ai_actions/ai_actions_guide",
1515
"ai_actions/install_ai_actions",
1616
"ai_actions/extend_ai_actions"
17-
], columns=4) =]]
18-
19-
## Explore AI Actions API
20-
21-
...
17+
], columns=4) =]]

docs/ai_actions/ai_actions_guide.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
description: AI Actions add-on helps editors by automating repetitive tasks.
2+
description: AI Actions LTS update helps editors by automating repetitive tasks.
33
---
44

55
# AI Actions product guide
66

77
## What are AI Actions
88

99
In the evolving landscape of digital experience, artificial intelligence becomes more and more important by enhancing user interaction and automating complex processes.
10-
[[= product_name =]] can be equipped with the AI Actions add-on, which harnesses AI's potential to automate time-consuming editorial tasks.
10+
[[= product_name =]] can be equipped with the AI Actions LTS update, which harnesses AI's potential to automate time-consuming editorial tasks.
1111
AI Actions is an extensible solution for integrating features provided by AI services into your workflows, all managed through a user-friendly interface.
1212

1313
Out-of-the-box, AI Actions includes two essential components: a framework package and an OpenAI connector package.
@@ -33,7 +33,7 @@ To begin using AI Actions, you must first [install the required packages and per
3333

3434
## How it works
3535

36-
AI Actions add-on is built upon the PHP framework.
36+
AI Actions LTS update is built upon the PHP framework.
3737
The framework package 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.
3838
This data can then be combined with user input.
3939
It's then passed to a service connector, such as the default OpenAI connector, for final processing on [[= product_name =]] side.
@@ -80,7 +80,7 @@ Handlers take parameters defined in the AI action type and configuration, combin
8080

8181
### Triggering actions from the UI
8282

83-
Among other elements, AI Actions add-on includes UI components for:
83+
Among other elements, AI Actions LTS update includes UI components for:
8484

8585
- AI action management in the **Admin** panel
8686
- text modification in online editor
@@ -92,7 +92,7 @@ Procedures are straightforward and intuitive, ensuring that users can quickly ac
9292

9393
### Triggering actions programmatically
9494

95-
AI Actions add-on exposes a REST API interface that allows for programmatic execution of AI actions.
95+
AI Actions LTS update exposes a REST API interface that allows for programmatic execution of AI actions.
9696
With the API, developers can automate tasks and execute actions on batches of content by integrating them into workflows.
9797
<!---By issuing commands through the API, developers can trigger actions based on external events:
9898
...--->
@@ -104,23 +104,23 @@ With the API, developers can automate tasks and execute actions on batches of co
104104
Users with the appropriate permissions, governed by role-based [policies](policies.md#ai-actions), can control the lifecycle of AI actions by creating, editing, executing, and deleting them.
105105
Additionally, AI action configurations can be enabled or disabled depending on the organization's needs.
106106

107-
![Configurations management screen](img/ai_actions_list.md)
107+
![Configurations management screen](img/ai_actions_list.png)
108108

109109
An intuitive AI Actions interface within the **Admin** panel displays a list of all available AI actions.
110110
Here, you can search for specific actions and filter them by type or status.
111111
By accessing the detailed view of individual AI actions, you can quickly review all their parameters.
112112

113113
### Extensibility
114114

115-
Built-in AI action types offer a good starting point, but the real power of the AI Actions add-on lies in extensibility.
115+
Built-in AI action types offer a good starting point, but the real power of the AI Actions LTS update lies in extensibility.
116116
Extending AI Actions opens up new possibilities for content management and editing.
117117
Developers can define new models and AI action types that use the existing AI service or even integrate additional services.
118118
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.
119119
For example, if this is your organization's requirement, a developer could write a handler that uses an AI service to <insert_a description and link to Marek's use case> generate complete articles based on a short description, or illustrations based on a body of an article.
120120

121121
## Use cases
122122

123-
Out of the box, after you configure access to the OpenAI service, the [[= product_name_base =]] AI Actions add-on comes with two action types that can help your organization with the following tasks.
123+
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.
124124

125125
### Refining text
126126

docs/ai_actions/install_ai_actions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
description: Install the AI Actions add-on.
2+
description: Install the AI Actions LTS update.
33
---
44

55
# Install AI Actions
66

7-
AI Actions are available as an add-on to [[= product_name =]] in version v4.6.x or higher, regardless of its edition.
7+
AI Actions are available as an LTS update to [[= product_name =]] in version v4.6.x or higher, regardless of its edition.
88
To use this feature you must first install the packages and configure them.
99

1010
## Install packages
@@ -29,7 +29,7 @@ Create an OpenAI account, [get an API key](https://help.openai.com/en/articles/4
2929

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

32-
```
32+
```bash
3333
###> ibexa/connector-openai ###
3434
OPENAI_API_KEY=sk-svcacct-AFCrCt1h2s3i4s5i6s7t8h9e0a1p2i3c4o5d6e
3535
###< ibexa/connector-openai ###
@@ -43,7 +43,7 @@ Create the `add_ai_actions.sql` file that contains the following code:
4343
[[= include_file('code_samples/ai_actions/config/add_ai_actions.sql') =]]
4444
```
4545

46-
Run the following command. where `<database_name>` is the same name that you defined when you [installed [[= product_name =]]](install_ibexa_dxp.md#change-installation-parameters).
46+
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).
4747

4848
```bash
4949
mysql -u root <database_name> < add_ai_actions.sql

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@
7777
<div class="notification__content">
7878
<h2>The latest release is v4.6</h2>
7979
<div>The <a href="release_notes/ibexa_dxp_v4.6/">latest version of Ibexa DXP is v4.6</a>. You can now update your application to the latest version.</div>
80+
<div>The newest LTS Update to Ibexa DXP v4.6 is <a href="release_notes/ibexa_dxp_v4.6/#ai-actions-lts-update">AI Actions</a>. Install it to let AI help you with editorial tasks.</div>
8081
</div>
8182
<div class="notification__cta">
8283
<a href="update_and_migration/from_4.5/update_from_4.5/">Update your application</a>

docs/pim/pim_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ You can build upon it to connect to a remote PIM or ERP system, pull product dat
151151

152152
![Remote PIM](img/remote_pim_support.png)
153153

154-
Remote PIM support is available in all [[= product_name =]] editions as of version v.4.6.0.
154+
Remote PIM support is available in all [[= product_name =]] editions as of version v4.6.0.
155155
An example implementation is delivered as an optional package that you can [install and customize](add_remote_pim_support.md) to fulfill your requirements.
156156

157157
#### Capabilities

docs/release_notes/ibexa_dxp_v4.6.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -681,3 +681,15 @@ The following view matchers have been introduced in Ibexa DXP v4.6.0:
681681
| [[= product_name_headless =]] | [[= product_name_exp =]] | [[= product_name_com =]] |
682682
|---------------|------------------|---------------|
683683
| [[[= product_name_headless =]] v4.6](https://github.com/ibexa/headless/releases/tag/v4.6.0) | [[[= product_name_exp =]] v4.6](https://github.com/ibexa/experience/releases/tag/v4.6.0) | [[[= product_name_com =]] v4.6](https://github.com/ibexa/commerce/releases/tag/v4.6.0) |
684+
685+
## AI Actions LTS update
686+
687+
The AI Actions LTS update enhances the usability and flexibility of [[=product_name=]] v4.6 LTS by harnessing the potential of artificial intelligence to automate time-consuming editorial tasks.
688+
By default, the AI Actions feature can help users with their work in following scenarios:
689+
690+
- Refining text: when editing a content item, users can request that a passage selected in online editor is modified, for example, by adjusting the length of the text, changing its tone, or correcting linguistic errors.
691+
- Generating alternative text: when working with images, users can ask AI to generate alternative text for them, which helps improve accessibility and SEO.
692+
693+
![AI Assistant](../ai_actions/img/ai_assistant.png)
694+
695+
For more information, see [AI Actions product guide](../ai_actions/ai_actions_guide.md).

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ nav:
320320
- Add search form to front page: templating/layout/add_search_form.md
321321
- AI Actions:
322322
- AI Actions: ai_actions/ai_actions.md
323-
- AI Actions Guide: ai_actions/ai_actions_guide.md
323+
- AI Actions guide: ai_actions/ai_actions_guide.md
324324
- Install AI Actions: ai_actions/install_ai_actions.md
325325
- Extend AI Actions: ai_actions/extend_ai_actions.md
326326
- PIM (Product management):

0 commit comments

Comments
 (0)