Skip to content

Commit

Permalink
added documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fashxp committed Feb 28, 2024
1 parent d1948ea commit c101f1a
Show file tree
Hide file tree
Showing 5 changed files with 136 additions and 7 deletions.
5 changes: 2 additions & 3 deletions doc/02_Platform_Version_Releases/2023.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,8 @@ Following table lists all Pimcore modules and their version included in platform
| [pimcore/headless-documents](https://github.com/pimcore/headless-documents) | 2.1 |
| [pimcore/direct-edit](https://github.com/pimcore/direct-edit) | 2.0 |
| [pimcore/data-hub-simple-rest](https://github.com/pimcore/data-hub-simple-rest) | 2.0 |
| [pimcore/data-hub-productsup](https://github.com/pimcore/data-hub-productsup) | 1.3 |
| [pimcore/data-hub-file-export](https://github.com/pimcore/data-hub-file-export) | 2.0 |
| [pimcore/data-hub-ci-hub](https://github.com/pimcore/data-hub-ci-hub) | 1.2 |
| [pimcore/data-hub-productsup](https://github.com/pimcore/data-hub-productsup) | 2.1 |
| [pimcore/data-hub-file-export](https://github.com/pimcore/data-hub-file-export) | 2.1 |
| [pimcore/data-quality-management-bundle](https://github.com/pimcore/data-quality-management-bundle) | 1.1 |
| [pimcore/data-hub-webhooks](https://github.com/pimcore/data-hub-webhooks) | 1.0 |
| [pimcore/backend-power-tools-bundle](https://github.com/pimcore/backend-power-tools-bundle) | 1.1 |
Expand Down
42 changes: 42 additions & 0 deletions doc/02_Platform_Version_Releases/2024.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# 2024.1

Following table lists all Pimcore modules and their version included in platform release 2024.1:

| Package Name | Included Version |
|---------------------------------------------------------------------------------------------------------------------|------------------|
| [pimcore/pimcore](https://github.com/pimcore/pimcore) | 11.2 |
| [pimcore/newsletter-bundle](https://github.com/pimcore/newsletter-bundle) | 1.1 |
| [pimcore/ecommerce-framework-bundle](https://github.com/pimcore/ecommerce-framework-bundle) | 1.0 |
| [pimcore/web-to-print-bundle](https://github.com/pimcore/web-to-print-bundle) | 1.2 |
| [pimcore/google-marketing-bundle](https://github.com/pimcore/google-marketing-bundle) | 1.0 |
| [pimcore/personalization-bundle](https://github.com/pimcore/personalization-bundle) | 1.0 |
| [pimcore/file-explorer-bundle](https://github.com/pimcore/file-explorer-bundle) | 1.0 |
| [pimcore/system-info-bundle](https://github.com/pimcore/system-info-bundle) | 1.0 |
| [ppimcore/admin-ui-classic-bundle](https://github.com/pimcore/admin-ui-classic-bundle) | 1.4 |
| [pimcore/frontend-permission-toolkit-bundle](https://github.com/pimcore/frontend-permission-toolkit) | 2.0 |
| [pimcore/object-merger](https://github.com/pimcore/object-merger) | 4.0 |
| [pimcore/output-data-config-toolkit-bundle](https://github.com/pimcore/output-data-config-toolkit) | 5.0 |
| [pimcore/perspective-editor](https://github.com/pimcore/perspective-editor) | 1.7 |
| [pimcore/web2print-tools-bundle](https://github.com/pimcore/web2print-tools) | 5.0 |
| [pimcore/customer-management-framework-bundle](https://github.com/pimcore/customer-data-framework) | 4.0 |
| [pimcore/data-hub](https://github.com/pimcore/data-hub) | 1.7 |
| [pimcore/data-importer](https://github.com/pimcore/data-importer) | 1.8 |
| [pimcore/workflow-designer](https://github.com/pimcore/workflow-designer) | 1.2 |
| [pimcore/translations-provider-interfaces](https://github.com/pimcore/translations-provider-interfaces) | 3.0 |
| [pimcore/statistics-explorer](https://github.com/pimcore/statistics-explorer) | 2.1 |
| [pimcore/portal-engine](https://github.com/pimcore/portal-engine) | 4.0 |
| [pimcore/openid-connect](https://github.com/pimcore/openid-connect) | 1.1 |
| [pimcore/headless-documents](https://github.com/pimcore/headless-documents) | 2.1 |
| [pimcore/direct-edit](https://github.com/pimcore/direct-edit) | 2.0 |
| [pimcore/data-hub-simple-rest](https://github.com/pimcore/data-hub-simple-rest) | 3.0 |
| [pimcore/data-hub-productsup](https://github.com/pimcore/data-hub-productsup) | 1.3 |
| [pimcore/data-hub-file-export](https://github.com/pimcore/data-hub-file-export) | 2.0 |
| [pimcore/data-hub-ci-hub](https://github.com/pimcore/data-hub-ci-hub) | 1.2 |
| [pimcore/data-quality-management-bundle](https://github.com/pimcore/data-quality-management-bundle) | 1.1 |
| [pimcore/data-hub-webhooks](https://github.com/pimcore/data-hub-webhooks) | 1.1 |
| [pimcore/backend-power-tools-bundle](https://github.com/pimcore/backend-power-tools-bundle) | 1.2 |
| [pimcore/static-resolver-bundle](https://github.com/pimcore/static-resolver-bundle) | 1.4 |
| [pimcore/workflow-automation-integration-bundle](https://github.com/pimcore/workflow-automation-integration-bundle) | 1.0 |
| [pimcore/ee-admin-ui-classic-light-theme-bundle](https://github.com/pimcore/ee-admin-ui-classic-light-theme-bundle) | 1.0 |
| [pimcore/copilot-bundle](https://github.com/pimcore/copilot-bundle) | 1.0 |
| [pimcore/generic-data-index-bundle](https://github.com/pimcore/generic-data-index-bundle) | 1.0 |
9 changes: 5 additions & 4 deletions doc/02_Platform_Version_Releases/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@
Following platform version releases are available.

| Version | Release Notes | Module Details | Is LTS | LTS support until |
|---------|------------------------------------------------|----------------------| ----- |--------------------|
| 2022.0 | - | [Details](2022.0.md) || August 2025 |
| 2023.1 | [Release Notes](../03_Release_Notes/2023.1.md) | [Details](2023.1.md) || - |
|---------|------------------------------------------------|----------------------| ----- |-------------------|
| 2022.0 | - | [Details](2022.0.md) || August 2025 |
| 2023.1 | [Release Notes](../03_Release_Notes/2023.1.md) | [Details](2023.1.md) || |
| 2023.2 | [Release Notes](../03_Release_Notes/2023.2.md) | [Details](2023.2.md) |||
| 2023.3 | [Release Notes](../03_Release_Notes/2023.3.md) | [Details](2023.3.md) || December 2025 |
| 2023.3 | [Release Notes](../03_Release_Notes/2023.3.md) | [Details](2023.3.md) || December 2025 |
| 2024.1 | [Release Notes](../03_Release_Notes/2024.1.md) | [Details](2024.1.md) |||

Community support of a platform version ends after release of next platform version. LTS labeled platform versions and
their corresponding module versions have extended LTS support.
86 changes: 86 additions & 0 deletions doc/03_Release_Notes/2024.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Release 2024.1
Here you will find all the important new features and release notes of the Platform Version 2024.1 release.

## Most Important New Features

### Pimcore Copilot
The Pimcore Copilot serves as the central starting point for executing various actions within the Pimcore backend. It
will open in a separate window, allowing you to initiate different actions to interact with Pimcore.

The available actions will be context-sensitive, offering different functionalities depending on the context from which
you access the Copilot. These actions will be configurable and customizable.

The Pimcore Copilot will feature a job execution engine and a job run overview, enabling users to track the status of
long-running jobs, abort running jobs, or restart already finished jobs.

Adding new actions can be done programmatically, as well as supported by a configuration window in the backend.
More Details see Pimcore Copilot Documentation (to do)

### Generic data index
Pimcore now offers a generic OpenSearch-based data index. This data index will be used as a central search engine and
data index for our future applications. For example, the new UI will use the data index to improve searching and
filtering of data objects, assets, and documents. This new index will significantly improve the search experience and
performance in future Pimcore versions. The goal is that this central data index will be used by different extensions,
without the need for each extension to have its own index and update queuing mechanism.

More Details see Generic data index documentation (to do)

## Additional improvements and housekeeping
Alongside the new features, the following improvements and housekeeping have been implemented:

- **Integrate data index into Portals**
The Pimcore Portal engine will be the first application of the new generic data index. Therefore, it will be powered
by OpenSearch in the future and share its data index with the new Pimcore UI. The index queue mechanism of the generic
data index has been improved compared to the Portal engine’s old index update processes. This makes indexing more
stable and performant.
- **[Workflow Designer] Upgrade NPM dependency to latest version**
The front-end dependencies of the workflow designer were upgraded to the latest version to ensure that no outdated
packages are used.
- **[Statistics explorer] Upgrade NPM dependency to latest version**
The front-end dependencies of the workflow designer were upgraded to the latest version to ensure that no outdated
packages are used.
- **[Translation Provider Interfaces] Deprecate Xplanation Integration**
The Xplanation support will be removed in future versions.
- **[Data Hub GraphQL] Add option to disable SQL condition field**
Due to the nature of SQL, a custom SQL condition option for the administrator of the data hub is a potential security
risk. The data hub therefore now supports disabling this field, and we recommend disabling it if you do not rely on this
feature. Already existing SQL conditions could be migrated to an event-based approach if there is no need to let the
administrator change the conditions in the UI. We are additionally evaluating to create further UI based filtering
options without the need for SQL conditions in future versions.

## Breaking changes
With the platform version 2024.1 we will introduce the following important changes:

- **[Portal Engine] Remove Pimcore 10.6 support**
As it is now based on the generic data index which is only available for Pimcore 11.x, we removed Pimcore 10.6 support.
- **[Portal Engine] Skip Elasticsearch support and switch to Open Search**
Take a look at the explanation in the “Additional improvements and housekeeping” section above.
- **[Portal Engine] Upgrade front-end dependencies**
The front-end dependencies of the portal engine were upgraded to the latest version to ensure that no outdated packages
are used.
- **[Data Hub Simple REST API] Skip Elasticsearch support and switch to Open Search**
For the same reason as for the Portal Engine, Pimcore switched from Elasticsearch to Open Search support.


### Support for Open Search
In 2021, Elasticsearch decided to switch their licensing model from the Apache 2.0 license to SSPL. This new license is
no longer an open-source license, as it limits the possibilities to provide managed services based on Elasticsearch.
Therefore, Amazon decided to fork Elasticsearch based on Version 7.10.2 and released it as a new product (OpenSearch)
under the Apache 2.0 license.
OpenSearch is now actively developed by Amazon, and they further improved it in Version 2.x. Because of better license
compatibility and market demand, we also decided to switch to OpenSearch with Pimcore Platform Version 2024.1.
This ensures that hosting Pimcore is still possible without any limitations or additional search engine licensing costs.

More Details see open search client documentation (to do)

## Extensions removed from Platform Version

- Advanced Object Search
- CI-Hub Integration

## Upgrade Notes

Before updating, also have a look at the following upgrade notes if relevant to your system:
(to do)


1 change: 1 addition & 0 deletions doc/03_Release_Notes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ Following list includes all available Platform Version release notes:
- [2023.1](./2023.1.md)
- [2023.2](./2023.2.md)
- [2023.3](./2023.3.md)
- [2024.1](./2024.1.md)

0 comments on commit c101f1a

Please sign in to comment.