Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
1 change: 1 addition & 0 deletions docs/api/rest_api/rest_api_authentication.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
description: To authenticate REST API communication you can use session (default), JWT, basic, OAuth and client certificate (SSL) authentication.
month_change: true
---

# REST API authentication
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
description: Data migration actions enable you to run special operations while executing data migrations, such as assigning Roles, Sections, Objects states, and so on.
page_type: reference
month_change: true
---

# Data migration actions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Manage data migrations by adding files, converting from Kaliop migration bundle, checking migration status, and setting up configuration.
month_change: true
month_change: false
---

# Managing migrations
Expand Down
1 change: 1 addition & 0 deletions docs/content_management/pages/create_custom_page_block.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
description: Create and configure custom Page blocks to add customized content to Pages.
month_change: true
---

# Create custom Page block
Expand Down
2 changes: 1 addition & 1 deletion docs/ibexa_products/ibexa_commerce.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Ibexa Commerce
description: Explore all of the key features, functionalities, and advantages of Ibexa Commerce, the most powerful edition that Ibexa DXP has to offer.
month_change: true
month_change: false
---

# Ibexa DXP Commerce edition product guide
Expand Down
2 changes: 1 addition & 1 deletion docs/ibexa_products/ibexa_experience.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Ibexa Experience
description: Learn about all the main attributes, features, and benefits of the customer-focused Ibexa Experience edition.
month_change: true
month_change: false
---

# Ibexa DXP Experience edition product guide
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
description: You can use Symfony HttpCache Proxy, Varnish or Fastly as reverse proxies with Ibexa DXP.
month_change: true
---

# Reverse proxy
Expand Down
1 change: 1 addition & 0 deletions docs/personalization/api_reference/recommendation_api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
description: Use HTTP GET request method to render recommendations.
month_change: true
---

# Recommendation API
Expand Down
2 changes: 2 additions & 0 deletions docs/personalization/enable_personalization.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---

Check warning on line 1 in docs/personalization/enable_personalization.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/enable_personalization.md#L1

[Ibexa.ReadingLevel] The grade level is 10.35. Aim for 8th grade or lower by using shorter sentences and words.
Raw output
{"message": "[Ibexa.ReadingLevel] The grade level is 10.35. Aim for 8th grade or lower by using shorter sentences and words.", "location": {"path": "docs/personalization/enable_personalization.md", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
description: Configure your project files to enable Personalization and set up items you want to track.
month_change: true
---

# Enable Personalization
Expand Down
1 change: 1 addition & 0 deletions docs/personalization/integrate_recommendation_service.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
description: Integrate recommendation service into your website.
month_change: true
---

# Integrate recommendation service
Expand Down
1 change: 1 addition & 0 deletions docs/personalization/tracking_integration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
description: See the methods of event tracking integration using tracking from server or from client-side.
month_change: true
---

# Tracking integration
Expand Down
1 change: 1 addition & 0 deletions docs/personalization/tracking_with_ibexa-tracker.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
description: Integrate tracking with a Google-style JavaScript.
month_change: true
---

# Track events with ibexa-tracker.js
Expand Down
1 change: 1 addition & 0 deletions docs/pim/product_api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
description: Use PHP API to manage products in PIM, their attributes, availability and prices.
month_change: true
---

# Product API
Expand Down
2 changes: 1 addition & 1 deletion docs/product_guides/product_guides.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Discover various Ibexa DXP features.
page_type: landing_page
month_change: true
month_change: false
---

# Product guides
Expand Down
73 changes: 73 additions & 0 deletions docs/resources/new_in_doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,79 @@ description: Overview of major recent additions to Ibexa DXP documentation.

This page contains recent highlights and notable changes in [[= product_name =]] documentation.

## October 2024

### Content management

- Added a caution at the end of the [Create custom Page block](https://doc.ibexa.co/en/master/content_management/pages/create_custom_page_block/#add-edit-template) article
- Added `add_block_to_available_blocks` to a [list of available data migration actions](https://doc.ibexa.co/en/latest/content_management/data_migration/data_migration_actions/#available-migration-actions)

### Infrastructure and maintenance

- Updated the [reverse proxy configuration instructions](https://doc.ibexa.co/en/master/infrastructure_and_maintenance/cache/http_cache/reverse_proxy/#varnish-and-basic-auth) by mentioning Basic Auth setup for Varnish
- Reorganized the [Updating Ibexa DXP](https://doc.ibexa.co/en/latest/update_and_migration/update_ibexa_dxp/) section to put information in logical order and remove duplicates
- [Added v4.6.11 to v4.6.12 update instructions](https://doc.ibexa.co/en/master/update_and_migration/from_4.6/update_from_4.6/#v4612)
- [Added v4.6.12 to v4.6.13 update instructions](https://doc.ibexa.co/en/master/update_and_migration/from_4.6/update_from_4.6/#v4613) mentioning a command to clean up duplicated entries in the `ezcontentobject_attribute` table
- Changed the [Update to v3.3](https://doc.ibexa.co/en/latest/update_and_migration/from_2.5/to_3.3/#b-update-the-app) instructions to help avoid an error at `composer update` stage
- Changed the instructions by adding a requirement to handle the [[= product_name_cloud =]] configuration:
- [Update to v4.0](https://doc.ibexa.co/en/master/update_and_migration/from_3.3/to_4.0/#ibexa-cloud)
- [Update to v3.3.latest](https://doc.ibexa.co/en/master/update_and_migration/from_3.3/update_from_3.3/#v3313)
- Added a suggestion to [remove obsolete database tables](https://doc.ibexa.co/en/master/update_and_migration/from_4.3/update_from_4.3_new_commerce/#update-the-database) that were used by a legacy Commerce package

## Personalization

- Added dynamic attribute submodels information by:
- mentioning them in [customizing the recommendation request](https://doc.ibexa.co/en/master/personalization/api_reference/recommendation_api/#customizing-the-recommendation-request) instructions
- describing them in [user documentation](https://doc.ibexa.co/projects/userguide/en/latest/personalization/recommendation_models/#dynamic-attributes)
- Added time-slot based models information by:
- changing the list of parameters available when [customizing the recommendation request](https://doc.ibexa.co/en/master/personalization/api_reference/recommendation_api/#customizing-the-recommendation-request)
- describing them in [user documentation](https://doc.ibexa.co/projects/userguide/en/master/personalization/recommendation_models/#time-slot-based-models)

- Updated configuration details (including endpoint addresses nad code examples) in multiple how-to articles:
- [Enable Personalization ](https://doc.ibexa.co/en/master/personalization/enable_personalization)
- [Integrate recommendation service](https://doc.ibexa.co/en/master/personalization/integrate_recommendation_service/)
- [Tracking integration](https://doc.ibexa.co/en/master/personalization/tracking_integration/)
- [Track events with ibexa-tracker.js](https://doc.ibexa.co/en/master/personalization/tracking_with_ibexa-tracker/)

### PIM

- Updated the [Product API](https://doc.ibexa.co/en/master/pim/product_api/) article by fixing method signatures and adding links to the PHP API reference

### PHP API

- Added missing classes in the following namespaces:
- [Ibexa\Contracts\AdminUi\Menu](https://doc.ibexa.co/en/master/api/php_api/php_api_reference/namespaces/ibexa-contracts-adminui-menu.html)
- [Ibexa\Contracts\Core\Pool](https://doc.ibexa.co/en/master/api/php_api/php_api_reference/namespaces/ibexa-contracts-core-pool.html)
- [Ibexa\Contracts\CoreSearch\Values\Query](https://doc.ibexa.co/en/master/api/php_api/php_api_reference/namespaces/ibexa-contracts-coresearch-values-query.html)
- [Ibexa\Contracts\ProductCatalog\Local\Attribute\ContextAwareValueValidatorInterface](https://doc.ibexa.co/en/master/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Local-Attribute-ContextAwareValueValidatorInterface.html)

### REST API

- Updated the [REST API authentication](https://doc.ibexa.co/en/master/api/rest_api/rest_api_authentication/) instructions


## September 2024

### Getting started

- Updated product version requirements and database connection configuration instructions in [Install Ibexa DXP with DDEV](https://doc.ibexa.co/en/master/getting_started/install_with_ddev/#2-configure-ddev)

### Infrastructure and maintenance

- Modified v4.5.x to v4.6 update instructions by adding [Update Solr configuration](https://doc.ibexa.co/en/master/update_and_migration/from_4.5/update_from_4.5/#update-solr-configuration) section
- [Added v4.6.8 to v4.6.11 update instructions](https://doc.ibexa.co/en/master/update_and_migration/from_4.6/update_from_4.6/#v4611)

### PHP API

- Added edition information to [PHP API reference](https://doc.ibexa.co/en/master/api/php_api/php_api_reference/) to aid navigation

### REST API
- Removed multiple obsolete RAML types from the [REST API reference](https://doc.ibexa.co/en/master/api/rest_api/rest_api_reference/rest_api_reference.html)

### User management

- Updated the OAuth server [installation instructions](https://doc.ibexa.co/en/master/users/oauth_server/#server-installation)

## August 2024

### Product guides
Expand Down
1 change: 1 addition & 0 deletions docs/update_and_migration/from_2.5/to_3.3.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
target_version: '3.3'
month_change: true
---

# Update the app to v3.3
Expand Down
5 changes: 5 additions & 0 deletions docs/update_and_migration/from_3.3/to_4.0.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---

Check warning on line 1 in docs/update_and_migration/from_3.3/to_4.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/update_and_migration/from_3.3/to_4.0.md#L1

[Ibexa.ReadingLevel] The grade level is 6.69. Aim for 8th grade or lower by using shorter sentences and words.
Raw output
{"message": "[Ibexa.ReadingLevel] The grade level is 6.69. Aim for 8th grade or lower by using shorter sentences and words.", "location": {"path": "docs/update_and_migration/from_3.3/to_4.0.md", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
description: Update your installation to v4.0 from the latest v3.3 version.
month_change: true
---

# Update from v3.3.x to v4.0

This update procedure applies if you are using v3.3.
Expand Down
1 change: 1 addition & 0 deletions docs/update_and_migration/from_3.3/update_from_3.3.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
description: Update your installation to the latest v3.3 version from an earlier v3.3 version.
month_change: true
---

# Update from v3.3.x to v3.3.latest
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
description: Update procedure to v4.4 for people who don't use Commerce packages and can remove them.
month_change: true
---
# Update with new Commerce packages

Expand Down
1 change: 1 addition & 0 deletions docs/update_and_migration/from_4.6/update_from_4.6.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
description: Update your installation to the latest v4.6 version from an earlier v4.6 version.
month_change: true
---

# Update from v4.6.x to v4.6.latest
Expand Down
52 changes: 52 additions & 0 deletions docs/users/update_basic_user_data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---

Check warning on line 1 in docs/users/update_basic_user_data.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/users/update_basic_user_data.md#L1

[Ibexa.ReadingLevel] The grade level is 9.45. Aim for 8th grade or lower by using shorter sentences and words.
Raw output
{"message": "[Ibexa.ReadingLevel] The grade level is 9.45. Aim for 8th grade or lower by using shorter sentences and words.", "location": {"path": "docs/users/update_basic_user_data.md", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
description: Update basic user account data from the console.
---

# Update basic user data from CLI

Multiple user management scenarios may result in having to update basic user account data, such as user status, the password, or email.
Especially, you may need to revoke user access by disabling the account when offboarding an employee, or change the user's forgotten password.

You can do it without accessing the Admin UI, by running a console command.
You reference the user account by passing the user login.

## Disable or enable user account

Disable the user account:

```bash
php bin/console ibexa:user:update-user --disable <login>
```

For example:

```bash
php bin/console ibexa:user:update-user --disable johndoe
```

Enable the user account:

```bash
php bin/console ibexa:user:update-user --enable <login>
```

## Change password

Change the password associated with the user account:

```bash
php bin/console ibexa:user:update-user --password <login>
```

After you run the command, enter the new password when prompted.
The command runs in silent mode and inputs are not echoed.

For more information about changing and revoking passwords, for example, when a security breach occurs, see [Passwords](passwords.md#revoking-passwords).

## Change email address

Change the email address associated with the user account:

```bash
php bin/console ibexa:user:update-user --email=<new_email_address> <login>
```
3 changes: 2 additions & 1 deletion docs/users/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ All such user accounts have the same underlying mechanism and enable you to cont
"users/user_management_guide",
"users/invitations",
"users/user_registration",
], columns=3) =]]
"users/update_basic_user_data"
], columns=4) =]]

## Authenticate users

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -423,6 +423,7 @@ nav:
- User setup:
- Invitations: users/invitations.md
- Registration: users/user_registration.md
- Update basic user data: users/update_basic_user_data.md
- User authentication:
- Login methods: users/login_methods.md
- Passwords: users/passwords.md
Expand Down
Loading