diff --git a/README.md b/README.md index 0024898a97..72ea999a8e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ + + # Ibexa DXP Developer Documentation This repository is the source for the [developer documentation for Ibexa](https://doc.ibexa.co/en/latest), diff --git a/docs/administration/project_organization/bundles.md b/docs/administration/project_organization/bundles.md index 5195b7eb24..4f594c6a18 100644 --- a/docs/administration/project_organization/bundles.md +++ b/docs/administration/project_organization/bundles.md @@ -12,7 +12,7 @@ You can also reuse the bundles you create in other projects or share them with t Many [[= product_name =]] functionalities are provided through separate bundles included in the installation. You can see the bundles that are automatically installed with [[= product_name =]] in the respective `composer.json` files. -For example, for Ibexa Headless, see the [JSON file on GitHub](https://github.com/ibexa/headless/blob/master/composer.json). +For example, for [[= product_name_headless =]], see the [JSON file on GitHub](https://github.com/ibexa/headless/blob/master/composer.json). !!! caution "Deprecated legacy Commerce bundles" diff --git a/docs/api/rest_api/extending_rest_api/adding_custom_media_type.md b/docs/api/rest_api/extending_rest_api/adding_custom_media_type.md index dd58fbde80..2d48c20b1d 100644 --- a/docs/api/rest_api/extending_rest_api/adding_custom_media_type.md +++ b/docs/api/rest_api/extending_rest_api/adding_custom_media_type.md @@ -19,7 +19,7 @@ You need the following elements: You can change the vendor name (from default `vnd.ibexa.api` to new `app.api` like in this example), or you can create a new media type in the default vendor (like `vnd.ibexa.api.Greeting` in the [Creating a new REST resource](creating_new_rest_resource.md) example). To do so, tag your new ValueObjectVisitor with `ibexa.rest.output.value_object.visitor` to add it to the existing `ValueObjectVisitorDispatcher`, and a new one will not be needed. This way, the `media-type` attribute is also easier to create, because the default `Output\Generator` uses this default vendor. - This example presents creating a new vendor as a good practice, to highlight that this is custom extensions that isn't available in a regular Ibexa DXP installation. + This example presents creating a new vendor as a good practice, to highlight that this is custom extensions that isn't available in a regular [[= product_name =]] installation. ## New `RestLocation` `ValueObjectVisitor` diff --git a/docs/api/rest_api/rest_api_usage/testing_rest_api.md b/docs/api/rest_api/rest_api_usage/testing_rest_api.md index e856cae41e..2222ce8c8a 100644 --- a/docs/api/rest_api/rest_api_usage/testing_rest_api.md +++ b/docs/api/rest_api/rest_api_usage/testing_rest_api.md @@ -32,7 +32,7 @@ Open a PHP shell in a terminal with `php -a` and copy-paste this co `$resource` URI should be edited to address the right domain. -On a freshly installed Ibexa DXP, `52` is the Content ID of the home page. If necessary, substitute `52` with the Content ID of an item from your database. +On a freshly installed [[= product_name =]], `52` is the Content ID of the home page. If necessary, substitute `52` with the Content ID of an item from your database. For a content creation example using PHP, see [Creating content with binary attachments](rest_requests.md#creating-content-with-binary-attachments) @@ -72,6 +72,6 @@ To test it, copy-paste this code into your browser console alongside a page from request.send(); ``` -On a freshly installed Ibexa DXP, `52` is the Content ID of the home page. If necessary, substitute `52` with the Content ID of an item from your database. +On a freshly installed [[= product_name =]], `52` is the Content ID of the home page. If necessary, substitute `52` with the Content ID of an item from your database. You can edit the `resource` URI to address another domain, but [cross-origin requests](rest_responses.md#cross-origin) must be allowed first. diff --git a/docs/cdp/cdp.md b/docs/cdp/cdp.md index 00351ef86a..ffec428f93 100644 --- a/docs/cdp/cdp.md +++ b/docs/cdp/cdp.md @@ -6,16 +6,16 @@ description: Ibexa CDP is a software system designed to collect and organize cus ## What is Ibexa CDP -Ibexa CDP helps you solve one of the hardest challenges facing business world today: +[[= product_name_cdp =]] helps you solve one of the hardest challenges facing business world today: building unique experiences for your customers. -With Ibexa CDP you will be able to track and aggregate data of your customers' activity on multiple channels. +With [[= product_name_cdp =]] you will be able to track and aggregate data of your customers' activity on multiple channels. It will allow you to create individual customer profiles that enable you to personalize their experience on your platform. ![Ibexa CDP control panel](img/cdp_control_panel.png) ## How it works -Ibexa CDP unifies customer data across your organization +[[= product_name_cdp =]] unifies customer data across your organization to help you activate your users and provide them with real-time engagement. With defined audiences you can target your user segments at the right time, through the most used channel, with the relevant message, content, or products. diff --git a/docs/cdp/cdp_activation.md b/docs/cdp/cdp_activation.md index f23e535a6d..0156b3a423 100644 --- a/docs/cdp/cdp_activation.md +++ b/docs/cdp/cdp_activation.md @@ -6,7 +6,7 @@ description: Step-by-step activation procedure of Ibexa CDP. ## Configuration -To configure Ibexa CDP, use the `ibexa.system..cdp` [configuration key](configuration.md#configuration-files): +To configure [[= product_name_cdp =]], use the `ibexa.system..cdp` [configuration key](configuration.md#configuration-files): ```yaml ibexa: @@ -27,12 +27,12 @@ ibexa: ``` All configuration settings are described below. -You can follow them step by step to set up your Ibexa CDP. +You can follow them step by step to set up your [[= product_name_cdp =]]. ### Segment group First, create a segment group in the Back Office. -It will serve as a container for all segments data generated by Ibexa CDP. +It will serve as a container for all segments data generated by [[= product_name_cdp =]]. Go to **Admin** -> **Segments** and select **Create**. Fill in name and identifier for a segment group. Choose wisely, as once connected to CDP Segment Group cannot be changed. @@ -41,14 +41,14 @@ Choose wisely, as once connected to CDP Segment Group cannot be changed. Next, add a segment group identifier to the configuration. -!!! caution "Ibexa CDP Segment Group" +!!! caution "[[= product_name_cdp =]] Segment Group" - After you create the Segment Group in the Back Office and connect it to Ibexa CDP, you cannot change it in any way, including edit its name. + After you create the Segment Group in the Back Office and connect it to [[= product_name_cdp =]], you cannot change it in any way, including edit its name. ## Account number Now, fill in the account number. -Log in to Ibexa CDP and in the top right corner, select available accounts. +Log in to [[= product_name_cdp =]] and in the top right corner, select available accounts. ![List of available accounts](img/cdp_accounts.png) @@ -58,7 +58,7 @@ A pop-up window displays with a list of all available accounts and their numbers ## Data export -You need to specify a source of the user data that Ibexa CDP will connect to. +You need to specify a source of the user data that [[= product_name_cdp =]] will connect to. To do so, go to **Data Manager** in **Tools** section and select **Create new dataflow**. It will take you to a Dataflow Creator, where in five steps you will set up a data streaming. @@ -86,7 +86,7 @@ There are two versions of this command `--draft/--no-draft`. The first one is used to send the test user data to the Data Manager. If it passes a validation test in the **Activation** section, use the latter one to send a full version. -Next, go back to Ibexa CDP and select **Validate & download**. +Next, go back to [[= product_name_cdp =]] and select **Validate & download**. If the file passes, you will see a confirmation message. Now, you can go to the **File mapping** section. @@ -149,7 +149,7 @@ In the Audience Builder, you can also connect created audiences to the activatio ## Activation -Activation synchronises data from Ibexa CDP to the Ibexa DXP. +Activation synchronises data from [[= product_name_cdp =]] to the [[= product_name =]]. When you specify a segment, you can activate it on multiple communication channels, such as newsletters or commercials. You can configure multiple activations based data flows. @@ -162,7 +162,7 @@ Next, you can fill in **Ibexa information** they must match the ones provided in - **Client Secret** and **Client ID** - are used to authenticate against Webhook endpoint. In the configuration they are taken from environment variables in `.env` file. -- **Segment Group Identifier** - identifier of the segment group in Ibexa DXP. It points to a segment group where all the CDP audiences will be stored. +- **Segment Group Identifier** - identifier of the segment group in [[= product_name =]]. It points to a segment group where all the CDP audiences will be stored. - **Base URL** - URL of your instance with added `/cdp/webhook` at the end. ![Ibexa Information - Activation](img/cdp_activation_ibexa_info.png) diff --git a/docs/cdp/cdp_installation.md b/docs/cdp/cdp_installation.md index 9e7b704caf..b6acf032a7 100644 --- a/docs/cdp/cdp_installation.md +++ b/docs/cdp/cdp_installation.md @@ -4,19 +4,19 @@ description: Installation of standalone Ibexa CDP package. # Ibexa CDP installation -There are three steps required to install Ibexa CDP. -First, you need to register your Ibexa CDP account, then you can download a CDP package and update the configuration. +There are three steps required to install [[= product_name_cdp =]]. +First, you need to register your [[= product_name_cdp =]] account, then you can download a CDP package and update the configuration. ## Register in Ibexa CDP dashboard -If you decide to acquire Ibexa CDP contact your sales representative, -they will provide you with a registration link to Ibexa CDP. +If you decide to acquire [[= product_name_cdp =]] contact your sales representative, +they will provide you with a registration link to [[= product_name_cdp =]]. After registration, you will get access to a separate instance where you will find data required for configuring, activating and using this feature. ## Install CDP package -Ibexa CDP comes in an additional package that is opt-in and needs to be downloaded separately. +[[= product_name_cdp =]] comes in an additional package that is opt-in and needs to be downloaded separately. To download it run: @@ -36,5 +36,5 @@ ibexa_cdp: stateless: true ``` -Now, you can configure Ibexa CDP. +Now, you can configure [[= product_name_cdp =]]. Go to [the activation documentation](cdp_activation.md) and follow the steps. diff --git a/docs/content_management/content_management_guide.md b/docs/content_management/content_management_guide.md index eb4dbec332..ddd1f5ee28 100644 --- a/docs/content_management/content_management_guide.md +++ b/docs/content_management/content_management_guide.md @@ -219,7 +219,7 @@ For example, you can build Pages that contain different recommendations, dependi ## How to get started -Once you have integrated the headless implementation, installed a local instance of [[= product_name =]] or set up an instance on Ibexa Cloud, you are ready to employ the content management features to good use. +Once you have integrated the headless implementation, installed a local instance of [[= product_name =]] or set up an instance on [[= product_name_cloud =]], you are ready to employ the content management features to good use. Since content management is an ongoing process, and, in your implementation, you might prefer focusing on other areas of configuration, the order of operations below is by all means conventional. diff --git a/docs/content_management/data_migration/data_migration.md b/docs/content_management/data_migration/data_migration.md index e02e2fdbf9..4ce6ea4210 100644 --- a/docs/content_management/data_migration/data_migration.md +++ b/docs/content_management/data_migration/data_migration.md @@ -5,7 +5,7 @@ page_type: landing_page # Data migration -Data migration allows exporting and importing selected data from an Ibexa DXP installation. +Data migration allows exporting and importing selected data from an [[= product_name =]] installation. [*Exporting*](exporting_data.md) data consists in saving selected Repository information in YAML format. [*Importing*](importing_data.md) reads migration YAML files and creates or modifies Repository content based on them. diff --git a/docs/content_management/data_migration/exporting_data.md b/docs/content_management/data_migration/exporting_data.md index 71a7b73cc2..24f348be0c 100644 --- a/docs/content_management/data_migration/exporting_data.md +++ b/docs/content_management/data_migration/exporting_data.md @@ -18,7 +18,7 @@ php bin/console ibexa:migrations:generate --type=content --mode=create ``` This generates a file containing all Content items. -Below you can see part of the output of the default Ibexa DXP installation. +Below you can see part of the output of the default [[= product_name =]] installation. ``` yaml - diff --git a/docs/content_management/data_migration/managing_migrations.md b/docs/content_management/data_migration/managing_migrations.md index 04007852dd..a4d76eb91f 100644 --- a/docs/content_management/data_migration/managing_migrations.md +++ b/docs/content_management/data_migration/managing_migrations.md @@ -11,7 +11,7 @@ If you want to convert a file from the format used by the to the current migration format, use the `ibexa:migrations:kaliop:convert` command. The source file must use Kaliop mode and type combinations. -The converter handles Kaliop types that are different from Ibexa types. +The converter handles Kaliop types that are different from [[= product_name_base =]] types. ``` bash php bin/console ibexa:migrations:kaliop:convert --input=kaliop_format.yaml --output=ibexa_format.yaml diff --git a/docs/content_management/field_types/field_type_reference/richtextfield.md b/docs/content_management/field_types/field_type_reference/richtextfield.md index b825a2aa84..737d1e109a 100644 --- a/docs/content_management/field_types/field_type_reference/richtextfield.md +++ b/docs/content_management/field_types/field_type_reference/richtextfield.md @@ -67,7 +67,7 @@ The XHTML5 format is used by the Online Editor. The custom DocBook format described below is subject to change and is not covered by backwards compatibility promise. -You can use the Ibexa flavor of the DocBook format in PHP API and in REST API requests +You can use the [[= product_name_base =]] flavor of the DocBook format in PHP API and in REST API requests by providing the DocBook content as a string. The following example shows how to pass DocBook content to a [create struct](creating_content.md#creating-content-item-draft): diff --git a/docs/content_management/forms/form_builder_guide.md b/docs/content_management/forms/form_builder_guide.md index f549c1f06b..c97bfb57d9 100644 --- a/docs/content_management/forms/form_builder_guide.md +++ b/docs/content_management/forms/form_builder_guide.md @@ -15,7 +15,7 @@ You can also manage your forms and review the results gathered from the website ## Availability -Form Builder is available in Ibexa Experience and Ibexa Commerce. +Form Builder is available in [[= product_name_exp =]] and [[= product_name_com =]]. ## How does Form Builder work diff --git a/docs/content_management/pages/ibexa_connect_scenario_block.md b/docs/content_management/pages/ibexa_connect_scenario_block.md index d1ec775acf..7097265c9c 100644 --- a/docs/content_management/pages/ibexa_connect_scenario_block.md +++ b/docs/content_management/pages/ibexa_connect_scenario_block.md @@ -4,17 +4,17 @@ description: Work with Ibexa Connect scenario block that retrieves and displays # Ibexa Connect scenario block -Ibexa Connect scenario block retrieves and displays data from an Ibexa Connect webhook. +[[= product_name_connect =]] scenario block retrieves and displays data from an [[= product_name_connect =]] webhook. Scenario block is a regular [Page block](page_blocks.md) and can be configured on field definition level as any other block. !!! caution When setting up your instance, ensure you have profiler enabled. - To set up Page Builder in Ibexa DXP, follow the [Page and Form tutorial](page_and_form_tutorial.md). + To set up Page Builder in [[= product_name =]], follow the [Page and Form tutorial](page_and_form_tutorial.md). ## Scenario block configuration -In the following example you can learn how to configure Ibexa Connect scenario block with two available templates: `company_customers` and `external_clients`. +In the following example you can learn how to configure [[= product_name_connect =]] scenario block with two available templates: `company_customers` and `external_clients`. ### Block templates @@ -46,15 +46,15 @@ Then, in `templates/blocks` directory under `default.html.twig`, provide your bl [[= include_file('code_samples/page/ibexa_connect_scenario_block/templates/blocks/default.html.twig') =]] ``` -In the following example, the configuration of the block is non-complex - block is only used to display the content transferred from an Ibexa Connect webhook. -At this point the Ibexa Connect scenario block is ready to be used in Page Builder. +In the following example, the configuration of the block is non-complex - block is only used to display the content transferred from an [[= product_name_connect =]] webhook. +At this point the [[= product_name_connect =]] scenario block is ready to be used in Page Builder. ### Configure Ibexa Connect scenario block in Page Builder -Now, you can configure Ibexa Connect scenario block in Page Builder. -To do it, in your Page add Ibexa Connect block by dragging it from the menu to a drop zone and enter block settings. +Now, you can configure [[= product_name_connect =]] scenario block in Page Builder. +To do it, in your Page add [[= product_name_connect =]] block by dragging it from the menu to a drop zone and enter block settings. -- In the **Basic** tab in **Webhook link** field, provide a link to an Ibexa Connect webhook, +- In the **Basic** tab in **Webhook link** field, provide a link to an [[= product_name_connect =]] webhook, for example, `https://connect.ibexa.co/3/scenarios/688/edit`: ![Ibexa Connect Basic tab](ibexa_connect_basic_tab.png) @@ -65,6 +65,6 @@ To do it, extend drop-down list in the **View** field and choose one of the avai ![Ibexa Connect Design tab](ibexa_connect_design_tab.png) Click **Submit** button to confirm. -After submitting the block, Page refreshes and Ibexa Connect block displays data from provided Ibexa Connect webhook. +After submitting the block, Page refreshes and [[= product_name_connect =]] block displays data from provided [[= product_name_connect =]] webhook. ![Ibexa Connect webhook preview](ibexa_connect_webhook_preview.png) \ No newline at end of file diff --git a/docs/content_management/url_management/url_management.md b/docs/content_management/url_management/url_management.md index dc169e9a28..ef84775438 100644 --- a/docs/content_management/url_management/url_management.md +++ b/docs/content_management/url_management/url_management.md @@ -95,13 +95,13 @@ For details, see the tables below. |--------------------|---------------------------------------------------------------------|---------------| | enabled | Enables link validation. | true | -For more information about Ibexa configuration, see [Configuration](configuration.md). +For more information about [[= product_name_base =]] configuration, see [Configuration](configuration.md). ### Custom protocol support You can extend the external URL address validation with a custom protocol. To do this, you must provide a service that implements the `Ibexa\Bundle\Core\URLChecker\URLHandlerInterface` interface: - +s ```php master !!! caution - If you want to use the [Platform.sh CLI](https://docs.platform.sh/administration/cli.html), you have to set it up for Ibexa Cloud. + If you want to use the [Platform.sh CLI](https://docs.platform.sh/administration/cli.html), you have to set it up for [[= product_name_cloud =]]. Consider using the following alias `ibexa_cloud` with a dedicated setup instead of `platform`: ```bash alias ibexa_cloud="PLATFORMSH_CLI_SESSION_ID=ibexa_cloud \ diff --git a/docs/getting_started/install_with_ddev.md b/docs/getting_started/install_with_ddev.md index c38cdf3db5..e03d17aec1 100644 --- a/docs/getting_started/install_with_ddev.md +++ b/docs/getting_started/install_with_ddev.md @@ -258,7 +258,7 @@ sed -i 's/ibexa_params.d/sites-enabled\/ibexa_params.d/' .ddev/nginx_full/ibexa. If you want to use HTTPS, you must add the following rule to avoid mixed content (HTTPS pages linking to HTTP resources): `fastcgi_param HTTPS $fcgi_https;` -For example, you can append it to Ibexa's FastCGI config: +For example, you can append it to [[= product_name_base =]]'s FastCGI config: ```bash echo 'fastcgi_param HTTPS $fcgi_https;' >> .ddev/nginx_full/ibexa_params.d/ibexa_fastcgi_params diff --git a/docs/getting_started/requirements.md b/docs/getting_started/requirements.md index ed797e0ac5..40970db8e0 100644 --- a/docs/getting_started/requirements.md +++ b/docs/getting_started/requirements.md @@ -112,24 +112,24 @@ Optionally if you intend to edit [PNG, SVG, GIF or WEBP files in the Image Edito !!! note "Ibexa Cloud" - ### Cloud hosting with Ibexa Cloud and Platform.sh + ### Cloud hosting with [[= product_name_cloud =]] and Platform.sh - In general, Ibexa Cloud supports all features and services of [Platform.sh](https://platform.sh/marketplace/ibexa/) that are compatible and supported by the [[= product_name =]] version you use. + In general, [[= product_name_cloud =]] supports all features and services of [Platform.sh](https://platform.sh/marketplace/ibexa/) that are compatible and supported by the [[= product_name =]] version you use. For example: - - Platform.sh provides Redis support for versions 3.2, 4.0 and 5.0. [[= product_name =]] supports Redis version 4.0 or higher, and recommends 5.0. As a result, Redis is supported on Ibexa Cloud in versions 4.0 and 5.0, but 5.0 is recommended. + - Platform.sh provides Redis support for versions 3.2, 4.0 and 5.0. [[= product_name =]] supports Redis version 4.0 or higher, and recommends 5.0. As a result, Redis is supported on [[= product_name_cloud =]] in versions 4.0 and 5.0, but 5.0 is recommended. Features or services supported by [[= product_name =]] but not covered by Platform.sh may be possible by means of a [custom integration](#custom-integrations). ### Ibexa Cloud Setup support matrix - All [[= product_name =]] features are supported in accordance with the example above. For example: As Legacy Bridge is not supported with v3, it is not supported on Ibexa Cloud either. + All [[= product_name =]] features are supported in accordance with the example above. For example: As Legacy Bridge is not supported with v3, it is not supported on [[= product_name_cloud =]] either. !!! note As Platform.sh does not support a configuration with multiple PostgreSQL databases, - for Ibexa Cloud / Platform.sh it is impossible to have a DFS table in a separate database. + for [[= product_name_cloud =]] / Platform.sh it is impossible to have a DFS table in a separate database. ### Recommended Ibexa Cloud setup @@ -145,9 +145,9 @@ Optionally if you intend to edit [PNG, SVG, GIF or WEBP files in the Image Edito - Verifying your requirements and ensuring they are supported by Platform.sh - Additional time for adaptation and configuration work, and testing by your development team - - Additional consulting/onboarding time with Platform.sh, Ibexa technical services, and/or one of the many partners with prior experience using Platform.sh with [[= product_name =]] + - Additional consulting/onboarding time with Platform.sh, [[= product_name_base =]] technical services, and/or one of the many partners with prior experience using Platform.sh with [[= product_name =]] - The cost and effort of this is not included in Ibexa Cloud subscription and will vary depending on the project. + The cost and effort of this is not included in [[= product_name_cloud =]] subscription and will vary depending on the project. ### Custom integrations diff --git a/docs/index.md b/docs/index.md index d10347dc62..7479e02c65 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,5 @@ + +
diff --git a/docs/infrastructure_and_maintenance/cache/http_cache/content_aware_cache.md b/docs/infrastructure_and_maintenance/cache/http_cache/content_aware_cache.md index 3ef6d3bc02..04290d4879 100644 --- a/docs/infrastructure_and_maintenance/cache/http_cache/content_aware_cache.md +++ b/docs/infrastructure_and_maintenance/cache/http_cache/content_aware_cache.md @@ -374,7 +374,7 @@ This section describes to how to debug problems related to HTTP cache. the HTTP cache sends to the client (web browser). It means you must be able to send requests to your origin (web server) that do not go through Varnish or Fastly. If you run Nginx and Varnish on premise, you should know what host and port number both Varnish and Nginx runs on. If you - perform tests on Fastly enabled environment on Ibexa Cloud provided by Platform.sh, you need to use the Platform.sh + perform tests on Fastly enabled environment on [[= product_name_cloud =]] provided by Platform.sh, you need to use the Platform.sh Dashboard to obtain the endpoint for Nginx. The following example shows how to debug and check why Fastly does not cache the front page properly. diff --git a/docs/infrastructure_and_maintenance/cache/http_cache/reverse_proxy.md b/docs/infrastructure_and_maintenance/cache/http_cache/reverse_proxy.md index 2ae8946988..dd54e1a99d 100644 --- a/docs/infrastructure_and_maintenance/cache/http_cache/reverse_proxy.md +++ b/docs/infrastructure_and_maintenance/cache/http_cache/reverse_proxy.md @@ -122,7 +122,7 @@ ibexa: !!! note "Invalidating Varnish cache using tokens" - In setups where the Varnish server IP can change (for example, on Ibexa Cloud), + In setups where the Varnish server IP can change (for example, on [[= product_name_cloud =]]), you can use token-based cache invalidation through [`ez_purge_acl`](https://github.com/ibexa/http-cache/blob/main/docs/varnish/vcl/varnish5.vcl#L174). In such situation, use strong, secure hash and make sure to keep the token secret. diff --git a/docs/infrastructure_and_maintenance/clustering/clustering.md b/docs/infrastructure_and_maintenance/clustering/clustering.md index c21d96a16c..521080723e 100644 --- a/docs/infrastructure_and_maintenance/clustering/clustering.md +++ b/docs/infrastructure_and_maintenance/clustering/clustering.md @@ -52,7 +52,7 @@ To avoid concurrent access to session data from front-end nodes, if possible you Session locking is available with `php-memcached`, and with `php-redis` (v4.2.0 and higher). -On Ibexa Cloud (and Platform.sh) Redis is preferred and supported. +On [[= product_name_cloud =]] (and Platform.sh) Redis is preferred and supported. ### Shared binary files @@ -141,7 +141,7 @@ manually importing its schema definition: ``` !!! note - On Ibexa Cloud (and Platform.sh) a separate DFS database is supported for MySQL only. + On [[= product_name_cloud =]] (and Platform.sh) a separate DFS database is supported for MySQL only. This example uses Doctrine connection named `dfs`: diff --git a/docs/infrastructure_and_maintenance/clustering/clustering_with_ddev.md b/docs/infrastructure_and_maintenance/clustering/clustering_with_ddev.md index c2e53e0cc3..92329ff420 100644 --- a/docs/infrastructure_and_maintenance/clustering/clustering_with_ddev.md +++ b/docs/infrastructure_and_maintenance/clustering/clustering_with_ddev.md @@ -25,7 +25,7 @@ The `ddev config --php-version` option should set the same PHP version as the pr Discover more commands in [DDEV documentation](https://ddev.readthedocs.io/en/latest/users/usage/commands/). -To run an Ibexa Cloud project locally, you may refer to [Ibexa Cloud and DDEV](ibexa_cloud_and_ddev.md) instead. +To run an [[= product_name_cloud =]] project locally, you may refer to [Ibexa Cloud and DDEV](ibexa_cloud_and_ddev.md) instead. ## Install search engine diff --git a/docs/infrastructure_and_maintenance/clustering/ibexa_cloud_and_ddev.md b/docs/infrastructure_and_maintenance/clustering/ibexa_cloud_and_ddev.md index 8b3953abd8..67742c62dc 100644 --- a/docs/infrastructure_and_maintenance/clustering/ibexa_cloud_and_ddev.md +++ b/docs/infrastructure_and_maintenance/clustering/ibexa_cloud_and_ddev.md @@ -4,7 +4,7 @@ description: Use DDEV to run an Ibexa Cloud project locally. # Ibexa Cloud and DDEV -Two ways are available to run an Ibexa Cloud project locally with DDEV: +Two ways are available to run an [[= product_name_cloud =]] project locally with DDEV: - [by using the Platform.sh's `ddev-platformsh` add-on](#with-the-ddev-platformsh-add-on) - [like other existing project, without this add-on](#without-the-platformsh-add-on). @@ -23,7 +23,7 @@ Two ways are available to run an Ibexa Cloud project locally with DDEV: To configure the [`ddev/ddev-platformsh` add-on](https://github.com/ddev/ddev-platformsh), you need a [Platform.sh API Token](https://docs.platform.sh/administration/cli/api-tokens.html). -The `ddev/ddev-platformsh` add-on configures the document root, the PHP version, the database and the cache pool according to the Ibexa Cloud configuration. About the search engine, the add-on can configure Elasticsearch but can't configure Solr. If you use Solr on Ibexa Cloud and want to add it to your DDEV stack, see [clustering with DDEV and `ibexa/ddev-solr` add-on](clustering_with_ddev.md#solr). +The `ddev/ddev-platformsh` add-on configures the document root, the PHP version, the database and the cache pool according to the [[= product_name_cloud =]] configuration. About the search engine, the add-on can configure Elasticsearch but can't configure Solr. If you use Solr on [[= product_name_cloud =]] and want to add it to your DDEV stack, see [clustering with DDEV and `ibexa/ddev-solr` add-on](clustering_with_ddev.md#solr). `COMPOSER_AUTH` from Platform.sh can't be used, because JSON commas are incorrectly interpreted by `--web-environment-add`, which sees them as multiple variable separators. But the variable must exist for Platform.sh `hooks` scripts to work. To use an `auth.json` file for this purpose, see [Using `auth.json`](install_with_ddev.md#using-authjson). @@ -32,7 +32,7 @@ You must remove Node.js and NVM installations as they're already included in DDE The following sequence of commands: -1. Downloads the Ibexa Cloud Platform.sh project from the default environment "production" into a new directory using [Platform.sh CLI alias `ibexa_cloud` defined in introduction](#ibexa-cloud-and-ddev). (Replace `` with the hash of your own project. See [`ibexa_cloud help get`](https://docs.platform.sh/administration/cli.html#3-use) for options like selecting another environment). +1. Downloads the [[= product_name_cloud =]] Platform.sh project from the default environment "production" into a new directory using [Platform.sh CLI alias `ibexa_cloud` defined in introduction](#ibexa-cloud-and-ddev). (Replace `` with the hash of your own project. See [`ibexa_cloud help get`](https://docs.platform.sh/administration/cli.html#3-use) for options like selecting another environment). 1. Configures a new DDEV project. 1. Ignores `.ddev/` directory from Git. (Some DDEV config could be committed like in [this documentation](https://ddev.readthedocs.io/en/latest/users/extend/customization-extendibility/#extending-configyaml-with-custom-configyaml-files).) 1. Sets Composer authentication by using an already existing `auth.json` file. @@ -72,7 +72,7 @@ The following example adapts the [manual method to run an already existing proje The following sequence of commands: -1. Downloads the Ibexa Cloud Platform.sh project from the default environment "production" into a new directory using [Platform.sh CLI alias `ibexa_cloud` defined in introduction](#ibexa-cloud-and-ddev). (Replace `` with the hash of your own project. See [`ibexa_cloud help get`](https://docs.platform.sh/administration/cli.html#3-use) for options like selecting another environment). +1. Downloads the [[= product_name_cloud =]] Platform.sh project from the default environment "production" into a new directory using [Platform.sh CLI alias `ibexa_cloud` defined in introduction](#ibexa-cloud-and-ddev). (Replace `` with the hash of your own project. See [`ibexa_cloud help get`](https://docs.platform.sh/administration/cli.html#3-use) for options like selecting another environment). 1. Configures a new DDEV project. 1. Ignores `.ddev/` directory from Git. (Some DDEV config could be committed like in [this documentation](https://ddev.readthedocs.io/en/latest/users/extend/customization-extendibility/#extending-configyaml-with-custom-configyaml-files).) 1. Starts the DDEV project. @@ -98,6 +98,6 @@ ddev describe ddev launch ``` -From there, services can be added to get closer to Ibexa Cloud Platform.sh architecture. +From there, services can be added to get closer to [[= product_name_cloud =]] Platform.sh architecture. `.platform/services.yaml` indicates the services used. Refer to [clustering with DDEV](clustering_with_ddev.md) for those additions. diff --git a/docs/infrastructure_and_maintenance/security/development_security.md b/docs/infrastructure_and_maintenance/security/development_security.md index d2a6af2554..22091e2b4f 100644 --- a/docs/infrastructure_and_maintenance/security/development_security.md +++ b/docs/infrastructure_and_maintenance/security/development_security.md @@ -100,7 +100,7 @@ See [Authenticating a user with multiple user provider](user_management.md#authe ## JWT authentication -To use [JWT authentication](https://jwt.io/) with Ibexa DXP, in the provided ` config/packages/lexik_jwt_authentication.yaml` file, +To use [JWT authentication](https://jwt.io/) with [[= product_name =]], in the provided `config/packages/lexik_jwt_authentication.yaml` file, modify the existing configuration by setting `authorization_header` to `enabled`: ``` yaml hl_lines="8" diff --git a/docs/infrastructure_and_maintenance/security/security_checklist.md b/docs/infrastructure_and_maintenance/security/security_checklist.md index ddce42c185..89bf40618a 100644 --- a/docs/infrastructure_and_maintenance/security/security_checklist.md +++ b/docs/infrastructure_and_maintenance/security/security_checklist.md @@ -31,7 +31,7 @@ make sure that your setup is secure. !!! note - On Ibexa Cloud, if `APP_SECRET` is not set, the system sets it to [`PLATFORM_PROJECT_ENTROPY`](https://docs.platform.sh/guides/symfony/environment-variables.html#symfony-environment-variables) + On [[= product_name_cloud =]], if `APP_SECRET` is not set, the system sets it to [`PLATFORM_PROJECT_ENTROPY`](https://docs.platform.sh/guides/symfony/environment-variables.html#symfony-environment-variables) ### Symfony production mode @@ -75,7 +75,7 @@ This is specially important for admin accounts and other privileged users. - Never go online with admin password set to `publish` or any other default value. - Introduce password quality checks. Make sure the checks are strict enough (length/complexity). - 16 characters is a quite secure minimum length. Do not go below 10. -- If using Ibexa DXP v4.5 or newer, enable the password rule that rejects any password which has been exposed in a public breach. +- If using [[= product_name =]] v4.5 or newer, enable the password rule that rejects any password which has been exposed in a public breach. !!! tip "Password rules" @@ -97,7 +97,7 @@ before they have logged in, including would-be attackers. If an attacker uses th address, the attacker does not receive the email. But they could still try to guess the password reset link. That's why this interval should be as short as possible. 5 minutes is often enough. -Ibexa DXP allows you to create and send invitations to create an account in the frontend as a customer, the Back Office +[[= product_name =]] allows you to create and send invitations to create an account in the frontend as a customer, the Back Office as an employee, or the Corporate Portal as a business partner. You can send invitations to individual users or in bulk. These invitations time out according to the parameter `ibexa.site_access.config.default.user_invitation.hash_expiration_time`. This can safely be longer than the "forgot password" time, @@ -191,7 +191,7 @@ Once you have properly configured secure user roles and permissions, to avoid ex - Avoid exposing servers on the open internet when not strictly required. - Ensure any servers, services, ports and virtual hosts that were opened for testing purposes are shut down before going live. -- Secure the database with a good password, keys, firewall, etc. Ensure that the database user used by the web app only has access to do the operations needed by Ibexa DXP. The Data Definition Language (DDL) commands (create, alter, drop, truncate, comment) are not needed for running Ibexa DXP, only for installing and upgrading it. If the web app user does not have these rights, then that reduces the damage that can be done if there is a security breach. +- Secure the database with a good password, keys, firewall, etc. Ensure that the database user used by the web app only has access to do the operations needed by [[= product_name =]]. The Data Definition Language (DDL) commands (create, alter, drop, truncate, comment) are not needed for running [[= product_name =]], only for installing and upgrading it. If the web app user does not have these rights, then that reduces the damage that can be done if there is a security breach. ### Security headers diff --git a/docs/infrastructure_and_maintenance/sessions.md b/docs/infrastructure_and_maintenance/sessions.md index 2bcbed8095..ef0b80ded6 100644 --- a/docs/infrastructure_and_maintenance/sessions.md +++ b/docs/infrastructure_and_maintenance/sessions.md @@ -119,7 +119,7 @@ Alternatively if you have needs to configure Redis servers dynamically: !!! note "Ibexa Cloud" - For Ibexa Cloud (and Platform.sh), this is already configured in `config/env/platformsh.php` based on `.platform.yaml` config. + For [[= product_name_cloud =]] (and Platform.sh), this is already configured in `config/env/platformsh.php` based on `.platform.yaml` config. If you are on `php-redis` v4.2.0 and higher, you can optionally tweak [`php-redis` settings](https://github.com/phpredis/phpredis#session-locking) for session locking. diff --git a/docs/permissions/permission_use_cases.md b/docs/permissions/permission_use_cases.md index f813a0836c..0127a3fc67 100644 --- a/docs/permissions/permission_use_cases.md +++ b/docs/permissions/permission_use_cases.md @@ -29,7 +29,7 @@ To publish, they must send the content for review to another User with proper pe - `content/edit` Use this setup with [[= product_name_exp =]] or [[= product_name_com =]] only, -as [[= product_name_content =]] does not allow the User to continue working with their content. +as [[= product_name_headless =]] does not allow the User to continue working with their content. ## Create and publish content diff --git a/docs/personalization/api_reference/recommendation_api.md b/docs/personalization/api_reference/recommendation_api.md index b6b7099507..33aef5decb 100644 --- a/docs/personalization/api_reference/recommendation_api.md +++ b/docs/personalization/api_reference/recommendation_api.md @@ -235,7 +235,7 @@ The following HTTP response codes are used by the recommendation controller: |403 Forbidden|Access denied.| |404 Not Found|The requested element was't found. It could be customer ID (or "mandator ID"), model ID, or scenario ID.| |409 Conflict|The requested combination of models and recommendation parameters can't return recommendations. This could happen, for example, if you request personalized recommendations for a user who has no history.| -|500 Internal Server Error|Unspecified error. Contact Ibexa support if this error is recurring.| +|500 Internal Server Error|Unspecified error. Contact [[= product_name_base =]] support if this error is recurring.| In case of errors, the response body contains human-readable error messages. Error messages can change, don't use them for automated processing. diff --git a/docs/personalization/api_reference/tracking_api.md b/docs/personalization/api_reference/tracking_api.md index 3a26616d01..f605cfaa3b 100644 --- a/docs/personalization/api_reference/tracking_api.md +++ b/docs/personalization/api_reference/tracking_api.md @@ -63,7 +63,7 @@ For example: !!! note - Even if item IDs cannot overlap in a customer's system, Ibexa recommends using + Even if item IDs cannot overlap in a customer's system, [[= product_name_base =]] recommends using different item types to provide independent tracking and cross-item type recommendations, such as, for example, "Users who read this article also watched these videos" or "Users who liked this gallery also read these articles". @@ -154,7 +154,7 @@ Like all other parameters, the category path must be URL-encoded and cannot cont The "categorypath" parameter offers the possibility to provide category-based recommendations without an explicit export of the structure of a customer's website. -If enabled by Ibexa, it is used for on-the-fly updating of item categories. +If enabled by [[= product_name_base =]], it is used for on-the-fly updating of item categories. If an item is moved to another category, it is handled as present in both categories until the old category ages out or is forcibly deleted. Multiple category locations of an item (multi-homing) are therefore possible. @@ -164,7 +164,7 @@ Multiple category locations of an item (multi-homing) are therefore possible. When you import your own item metadata by using the Personalization server import interface, you might choose to not provide the category path in the Click event. - Category path is required by default, contact Ibexa to change the default + Category path is required by default, contact [[= product_name_base =]] to change the default configuration. ## Track events @@ -186,7 +186,7 @@ For a list of embedded parameters that each of the events may use, see the follo |`customerid`|A customer ID (for example "00000"). Can be used to identify a website in installations that [hosts multiple SiteAccesses]([[= user_doc =]]/personalization/use_cases/#multiple-website-hosting).|alphanumeric| |userid|A user's ID on the website of the customer. It could be an internal customer code, a session code or a cookie for anonymous users.|URL-encoded alphanumeric| |`itemtypeid`|Item type ID.|1 to 2147483647| -|`itemid`|A unique ID of the item the user has clicked.
String-based identifiers are also supported as item IDs to track content on a website, but it is discouraged due to fraud and security issues. If you are unable to provide numeric identifiers for the tracking process, contact Ibexa for further information and implementation notes.|1 to 2147483647| +|`itemid`|A unique ID of the item the user has clicked.
String-based identifiers are also supported as item IDs to track content on a website, but it is discouraged due to fraud and security issues. If you are unable to provide numeric identifiers for the tracking process, contact [[= product_name_base =]] for further information and implementation notes.|1 to 2147483647| |`sourceuserid`|User identifier valid up to now(usually some anonymous session ID)|URL-encoded alphanumeric| |`targetuserid`|User identifier valid from now on (usually an account ID or login name)|URL-encoded alphanumeric| diff --git a/docs/personalization/enable_personalization.md b/docs/personalization/enable_personalization.md index 72b721423b..42a76fa5dc 100644 --- a/docs/personalization/enable_personalization.md +++ b/docs/personalization/enable_personalization.md @@ -5,11 +5,11 @@ description: Configure your project files to enable Personalization and set up i # Enable Personalization The Personalization service is based on a client-server architecture. -To enable it, you must set up authentication parameters that you receive from Ibexa. +To enable it, you must set up authentication parameters that you receive from [[= product_name_base =]]. ## Get authentication parameters -First, either you or another Ibexa user responsible for managing the [[= product_name =]] +First, either you or another [[= product_name_base =]] user responsible for managing the [[= product_name =]] instance must [request access to the service]([[= user_doc =]]/personalization/enabling_personalization/#request-access-to-the-server). ## Set up customer credentials diff --git a/docs/personalization/integrate_recommendation_service.md b/docs/personalization/integrate_recommendation_service.md index d2a7115dba..454217435c 100644 --- a/docs/personalization/integrate_recommendation_service.md +++ b/docs/personalization/integrate_recommendation_service.md @@ -168,7 +168,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 Ibexa Connect [webhook](https://doc.ibexa.co/projects/connect/en/latest/tools/webhooks/). +Out of many options, it could be an [[= product_name_connect =]] [webhook](https://doc.ibexa.co/projects/connect/en/latest/tools/webhooks/). The endpoint must meet the following requirements: - must support POST requests diff --git a/docs/personalization/personalization_brochure.md b/docs/personalization/personalization_brochure.md index 7ef4b4953e..4e3f7520e2 100644 --- a/docs/personalization/personalization_brochure.md +++ b/docs/personalization/personalization_brochure.md @@ -89,7 +89,7 @@ Create websites with content targeted at your customers. Deliver your visitors r Help users find content of their interest quicker, use words to appeal to individual customers, as well as segments. -Enrich customer data by integrating Ibexa Personalization with other systems such as ERP, CRMs. +Enrich customer data by integrating [[= product_name_base =]] Personalization with other systems such as ERP, CRMs. Track user’s scenarios and develop strategies that match your strategies and improve engagement. ### Satisfy customer expectations diff --git a/docs/release_notes/ez_platform_v1.10.0.md b/docs/release_notes/ez_platform_v1.10.0.md index 0f8dc18e49..e20b216a65 100644 --- a/docs/release_notes/ez_platform_v1.10.0.md +++ b/docs/release_notes/ez_platform_v1.10.0.md @@ -1,3 +1,5 @@ + + # eZ Platform v1.10.0 diff --git a/docs/release_notes/ez_platform_v1.11.0.md b/docs/release_notes/ez_platform_v1.11.0.md index d02578a691..663e49697b 100644 --- a/docs/release_notes/ez_platform_v1.11.0.md +++ b/docs/release_notes/ez_platform_v1.11.0.md @@ -1,3 +1,5 @@ + + # eZ Platform v1.11.0 **The FAST TRACK v1.11.0 release of eZ Platform and eZ Platform Enterprise Edition is available as of August 24, 2017.** diff --git a/docs/release_notes/ez_platform_v1.12.0.md b/docs/release_notes/ez_platform_v1.12.0.md index ac6aee42d5..526964170b 100644 --- a/docs/release_notes/ez_platform_v1.12.0.md +++ b/docs/release_notes/ez_platform_v1.12.0.md @@ -1,3 +1,5 @@ + + # eZ Platform v1.12.0 **The FAST TRACK v1.12.0 release of eZ Platform and eZ Platform Enterprise Edition is available as of October 31, 2017.** diff --git a/docs/release_notes/ez_platform_v1.13.0_lts.md b/docs/release_notes/ez_platform_v1.13.0_lts.md index 898b71a22d..2500f5791e 100644 --- a/docs/release_notes/ez_platform_v1.13.0_lts.md +++ b/docs/release_notes/ez_platform_v1.13.0_lts.md @@ -1,3 +1,5 @@ + + # eZ Platform v1.13.0 **The Long Term Support v1.13.0 release of eZ Platform and eZ Platform Enterprise Edition is available as of December 22, 2017.** diff --git a/docs/release_notes/ez_platform_v1.7.0_lts.md b/docs/release_notes/ez_platform_v1.7.0_lts.md index 9e6bf4a3e0..b3009ae100 100644 --- a/docs/release_notes/ez_platform_v1.7.0_lts.md +++ b/docs/release_notes/ez_platform_v1.7.0_lts.md @@ -1,3 +1,5 @@ + + # eZ Platform v1.7.0 LTS diff --git a/docs/release_notes/ez_platform_v1.8.0.md b/docs/release_notes/ez_platform_v1.8.0.md index 638d5de08a..f688fbfc85 100644 --- a/docs/release_notes/ez_platform_v1.8.0.md +++ b/docs/release_notes/ez_platform_v1.8.0.md @@ -1,3 +1,5 @@ + + # eZ Platform v1.8.0 **The FAST TRACK v1.8.0 release of eZ Platform and eZ Platform Enterprise Edition is available as of February 16, 2017.** diff --git a/docs/release_notes/ez_platform_v1.9.0.md b/docs/release_notes/ez_platform_v1.9.0.md index 54a9976a04..d46df4da42 100644 --- a/docs/release_notes/ez_platform_v1.9.0.md +++ b/docs/release_notes/ez_platform_v1.9.0.md @@ -1,3 +1,5 @@ + + # eZ Platform v1.9.0 diff --git a/docs/release_notes/ez_platform_v2.0.0.md b/docs/release_notes/ez_platform_v2.0.0.md index d16b321d93..f19dc859aa 100644 --- a/docs/release_notes/ez_platform_v2.0.0.md +++ b/docs/release_notes/ez_platform_v2.0.0.md @@ -1,3 +1,5 @@ + + # eZ Platform v2.0.0 **Version number**: v2.0.0 diff --git a/docs/release_notes/ez_platform_v2.1.0.md b/docs/release_notes/ez_platform_v2.1.0.md index d55b07200f..1afca1d76a 100644 --- a/docs/release_notes/ez_platform_v2.1.0.md +++ b/docs/release_notes/ez_platform_v2.1.0.md @@ -1,3 +1,5 @@ + + # eZ Platform v2.1.0 **Version number**: v2.1.0 diff --git a/docs/release_notes/ez_platform_v2.2.0.md b/docs/release_notes/ez_platform_v2.2.0.md index 71ec6b2310..6d9d43c536 100644 --- a/docs/release_notes/ez_platform_v2.2.0.md +++ b/docs/release_notes/ez_platform_v2.2.0.md @@ -1,3 +1,5 @@ + + # eZ Platform v2.2.0 **Version number**: v2.2.0 diff --git a/docs/release_notes/ez_platform_v2.3.md b/docs/release_notes/ez_platform_v2.3.md index 0791b428ee..aa9c404f4b 100644 --- a/docs/release_notes/ez_platform_v2.3.md +++ b/docs/release_notes/ez_platform_v2.3.md @@ -1,3 +1,5 @@ + + # eZ Platform v2.3 **Version number**: v2.3 diff --git a/docs/release_notes/ez_platform_v2.4.md b/docs/release_notes/ez_platform_v2.4.md index c451e7967d..2dd36df25f 100644 --- a/docs/release_notes/ez_platform_v2.4.md +++ b/docs/release_notes/ez_platform_v2.4.md @@ -1,3 +1,5 @@ + + # eZ Platform v2.4 **Version number**: v2.4 diff --git a/docs/release_notes/ez_platform_v2.5.md b/docs/release_notes/ez_platform_v2.5.md index c15a22c14a..ef855fde00 100644 --- a/docs/release_notes/ez_platform_v2.5.md +++ b/docs/release_notes/ez_platform_v2.5.md @@ -2,6 +2,7 @@ description: eZ Platform v2.5 is the last Long Term Support release in the v2 line, currently after End of Maintenance. --- + # eZ Platform v2.5 **Version number**: v2.5 diff --git a/docs/release_notes/ez_platform_v3.0.md b/docs/release_notes/ez_platform_v3.0.md index 68ddaabc02..cd5c63b822 100644 --- a/docs/release_notes/ez_platform_v3.0.md +++ b/docs/release_notes/ez_platform_v3.0.md @@ -1,3 +1,5 @@ + + # eZ Platform v3.0 **Version number**: v3.0 diff --git a/docs/release_notes/ez_platform_v3.0_deprecations.md b/docs/release_notes/ez_platform_v3.0_deprecations.md index 6a08912dac..ede5ed6a81 100644 --- a/docs/release_notes/ez_platform_v3.0_deprecations.md +++ b/docs/release_notes/ez_platform_v3.0_deprecations.md @@ -1,3 +1,5 @@ + + # eZ Platform v3.0 deprecations and backwards compatibility breaks This page lists backwards compatibility breaks and deprecations introduced in eZ Platform v3.0. diff --git a/docs/release_notes/ez_platform_v3.1.md b/docs/release_notes/ez_platform_v3.1.md index 5e789fed9b..ab7769c0de 100644 --- a/docs/release_notes/ez_platform_v3.1.md +++ b/docs/release_notes/ez_platform_v3.1.md @@ -1,3 +1,5 @@ + + # eZ Platform v3.1 **Version number**: v3.1 diff --git a/docs/release_notes/ibexa_dxp_v3.2.md b/docs/release_notes/ibexa_dxp_v3.2.md index a7b8a1ecdb..a6087cdf77 100644 --- a/docs/release_notes/ibexa_dxp_v3.2.md +++ b/docs/release_notes/ibexa_dxp_v3.2.md @@ -1,3 +1,5 @@ + + # Ibexa DXP v3.2 **Version number**: v3.2 @@ -26,7 +28,7 @@ and use assets such as images directly from the DAM in your content. ### Autosave -Ibexa Platform can now save your edits in a Content item or product automatically to help you preserve the progress in an event of a failure. +[[= product_name_base =]] Platform can now save your edits in a Content item or product automatically to help you preserve the progress in an event of a failure. For more information, see [Autosave](https://doc.ibexa.co/projects/userguide/en/latest/publishing/publishing/#autosave). ### Aggregation API diff --git a/docs/release_notes/ibexa_dxp_v3.3.md b/docs/release_notes/ibexa_dxp_v3.3.md index ed5d4098a1..b753ce7f0c 100644 --- a/docs/release_notes/ibexa_dxp_v3.3.md +++ b/docs/release_notes/ibexa_dxp_v3.3.md @@ -2,6 +2,8 @@ description: Ibexa DXP v3.3 is a Long Term Support release that offers a new Personalization UI, Image Editor and a data migration bundle. --- + + # Ibexa DXP v3.3 **Version number**: v3.3 @@ -20,7 +22,7 @@ This release brings a completely reconstructed user interface of the Personaliza ### Symfony Flex -Ibexa DXP is now installed using [Symfony Flex](https://symfony.com/doc/current/quick_tour/flex_recipes.html). +[[= product_name =]] is now installed using [Symfony Flex](https://symfony.com/doc/current/quick_tour/flex_recipes.html). See [the updated installation instruction](https://doc.ibexa.co/en/3.3/getting_started/install_ez_platform) for a new guide to installing the product. @@ -88,5 +90,5 @@ See [list of changes in Symfony 5.2](https://symfony.com/blog/symfony-5-2-curate ### Symfony 5.4 -The version v3.3.15 moves Ibexa DXP to Symfony 5.4. +The version v3.3.15 moves [[= product_name =]] to Symfony 5.4. For more information, see [Symfony 5.4 documentation](https://symfony.com/releases/5.4) and [update documentation](update_from_3.3.md#3315). diff --git a/docs/release_notes/ibexa_dxp_v4.0.md b/docs/release_notes/ibexa_dxp_v4.0.md index 14977b76dd..7332181ed4 100644 --- a/docs/release_notes/ibexa_dxp_v4.0.md +++ b/docs/release_notes/ibexa_dxp_v4.0.md @@ -1,3 +1,5 @@ + + # Ibexa DXP v4.0 **Version number**: v4.0 diff --git a/docs/release_notes/ibexa_dxp_v4.0_deprecations.md b/docs/release_notes/ibexa_dxp_v4.0_deprecations.md index a04495f5a8..e157a5b387 100644 --- a/docs/release_notes/ibexa_dxp_v4.0_deprecations.md +++ b/docs/release_notes/ibexa_dxp_v4.0_deprecations.md @@ -1,6 +1,8 @@ + + # Ibexa DXP v4.0 deprecations and backwards compatibility breaks -Ibexa DXP v4.0 introduces changes to significant parts of the code +[[= product_name =]] v4.0 introduces changes to significant parts of the code to align with the product name change from earlier eZ Platform. These changes include changing repository names, namespaces, filenames, function names, and others. @@ -10,7 +12,7 @@ using the older naming should function without change. ## Namespaces -Namespaces in the product which referred to old product names now use the Ibexa name. +Namespaces in the product which referred to old product names now use the [[= product_name_base =]] name. All namespace changes are listed in the `ibexa/compatibility-layer` repository. @@ -84,7 +86,7 @@ Other package-specific configuration keys have also been updated. ## Service names -Service names which referred to old product names now use the Ibexa name. +Service names which referred to old product names now use the [[= product_name_base =]] name. All service name changes are listed in the `ibexa/compatibility-layer` repository. @@ -93,7 +95,7 @@ for a full comparison of old and new names. ## Service tags -Service tag which referred to old product names now use the Ibexa name. +Service tag which referred to old product names now use the [[= product_name_base =]] name. All service tag changes are listed in the `ibexa/compatibility-layer` repository. diff --git a/docs/release_notes/ibexa_dxp_v4.1.md b/docs/release_notes/ibexa_dxp_v4.1.md index 045491de9a..a8dfb0eb7a 100644 --- a/docs/release_notes/ibexa_dxp_v4.1.md +++ b/docs/release_notes/ibexa_dxp_v4.1.md @@ -1,6 +1,7 @@ --- description: Ibexa DXP v4.1 enhances the PIM capabilities, adds a Measurement Field Type and attribute and a Dynamic Targeting block for the Page Builder. --- + # Ibexa DXP v4.1 diff --git a/docs/release_notes/ibexa_dxp_v4.2.md b/docs/release_notes/ibexa_dxp_v4.2.md index e893efaae3..507501d7e7 100644 --- a/docs/release_notes/ibexa_dxp_v4.2.md +++ b/docs/release_notes/ibexa_dxp_v4.2.md @@ -2,6 +2,8 @@ description: Ibexa DXP v4.2 adds the Customer Portal and user management capabilities, and enriches PIM with catalogs, product variants and product assets. --- + + # Ibexa DXP v4.2 **Version number**: v4.2 @@ -203,7 +205,7 @@ You can now hide and reveal Content items in data migrations by using the [`hide ### Fastly shielding -Ibexa DXP now supports Fastly shielding. +[[= product_name =]] now supports Fastly shielding. ## Deprecations @@ -225,12 +227,12 @@ a `SegmentGroup` and `Segment` objects respectively, instead of numerical IDs. ### Ibexa CDP -Ibexa Customer Data Center allows you to collect, connect and organize customer data from multiple sources. +[[= product_name_base =]] Customer Data Center allows you to collect, connect and organize customer data from multiple sources. You can use them to build segments that will allow you to create personalized customer experience for your brand. This is a standalone package that you can install along every product edition (Content, Experience, Commerce). -Ibexa CDP is also compatible with Ibexa v3.3. +[[= product_name_cdp =]] is also compatible with [[= product_name_base =]] v3.3. ![CDP Control Panel](img/4.2_cdp_control_panel.png) diff --git a/docs/release_notes/ibexa_dxp_v4.3.md b/docs/release_notes/ibexa_dxp_v4.3.md index 503d719d63..6d7cefb614 100644 --- a/docs/release_notes/ibexa_dxp_v4.3.md +++ b/docs/release_notes/ibexa_dxp_v4.3.md @@ -1,6 +1,7 @@ --- description: Ibexa DXP v4.3 adds the improvements to the Customer Portal, PIM and SEO. --- + # Ibexa DXP v4.3 diff --git a/docs/release_notes/ibexa_dxp_v4.4.md b/docs/release_notes/ibexa_dxp_v4.4.md index 5813201566..fab99d7fa1 100644 --- a/docs/release_notes/ibexa_dxp_v4.4.md +++ b/docs/release_notes/ibexa_dxp_v4.4.md @@ -1,6 +1,7 @@ --- description: Ibexa DXP v4.4 adds the improvements to the Welcome Page, All-new Ibexa Commerce packages and Fastly IO. --- + # Ibexa DXP v4.4 @@ -92,7 +93,7 @@ provide the best recommendations. You can now take advantage of [Ibexa Connect](https://www.ibexa.co/products/ibexa-connect), an iPaaS (integration platform-as-a-service) which allows you to connect Ibexa DXP with third-party applications. -Ibexa Connect features a low-code drag-and-drop interface and hundreds of connectors to different services +[[= 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 [Ibexa Connect documentation](https://doc.ibexa.co/projects/connect/en/latest/). @@ -143,7 +144,7 @@ The following Commerce packages are deprecated as of this release and will be re - `ibexa/commerce-shop` - `ibexa/commerce-shop-ui` -They will be maintained by Ibexa with fixes, including security fixes, but they won't be further developed. +They will be maintained by [[= product_name_name =]] with fixes, including security fixes, but they won't be further developed. Old packages are replaced by [the all-new Ibexa Commerce packages](#all-new-ibexa-commerce-packages) with more to come in the upcoming releases. diff --git a/docs/release_notes/ibexa_dxp_v4.5.md b/docs/release_notes/ibexa_dxp_v4.5.md index bff15f6ef2..58c16012f8 100644 --- a/docs/release_notes/ibexa_dxp_v4.5.md +++ b/docs/release_notes/ibexa_dxp_v4.5.md @@ -2,6 +2,8 @@ description: Ibexa DXP v4.5 adds new features to Ibexa Commerce, translation comparison, and a number of improvements to Customer Portal and Personalization. --- + + # Ibexa DXP v4.5 **Version number**: v4.5 @@ -121,7 +123,7 @@ In this release, the CDP configuration becomes more generic and allows supporting other transport types accepted by CDP. Currently, only `stream_file` transport is supported and can be initialized from the configuration. -Ibexa DXP v4.5 adds the abstraction that allows you to implement other transport types from third parties. +[[= product_name =]] v4.5 adds the abstraction that allows you to implement other transport types from third parties. For more information, see [CDP configuration](https://doc.ibexa.co/en/4.5/cdp/cdp_activation/#configuration). ### API improvements @@ -202,7 +204,7 @@ See [Breached passwords](https://doc.ibexa.co/en/4.5/users/user_management/#brea ### Ibexa Connect -For list of changes in Ibexa 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](https://doc.ibexa.co/projects/connect/en/latest/general/ibexa_app_release_notes/). ### Deprecations diff --git a/docs/resources/contributing/package_structure.md b/docs/resources/contributing/package_structure.md index 39843a2330..30fe79ef10 100644 --- a/docs/resources/contributing/package_structure.md +++ b/docs/resources/contributing/package_structure.md @@ -7,7 +7,7 @@ description: All code contributions to Ibexa DXP must follow package and bundle If you wish to contribute to [[= product_name =]] development, you need to adhere to the package and bundle structure and namespace standards. -The following conventions apply to contributions to Ibexa core code, not to third party packages. +The following conventions apply to contributions to [[= product_name_base =]] core code, not to third party packages. !!! note diff --git a/docs/resources/release_process_and_roadmap.md b/docs/resources/release_process_and_roadmap.md index 1600017685..6e88e44083 100644 --- a/docs/resources/release_process_and_roadmap.md +++ b/docs/resources/release_process_and_roadmap.md @@ -8,18 +8,18 @@ description: "Ibexa DXP releases new versions periodically in different flavors: [[= product_name =]] has three distributions: -- [[= product_name_content =]] is a multichannel and headless content management system. +- [[= product_name_headless =]] is a multichannel and headless content management system. - [[= product_name_exp =]] is a modern modular Digital Experience Platform to build outstanding customer experiences - [[= product_name_com =]] is a commerce-ready B2B DXP designed to digitalize your business from customer awareness to purchase and beyond. -Additionally, [[= product_name =]] also has an open-source version called Ibexa OSS. -Ibexa OSS is developed by Ibexa together with the open source community. -The Ibexa OSS code is available on GitHub under the GPLv2 license. +Additionally, [[= product_name =]] also has an open-source version called [[= product_name_oss =]]. +[[= product_name_oss =]] is developed by [[= product_name_base =]] together with the open source community. +The [[= product_name_oss =]] code is available on GitHub under the GPLv2 license. It comes with no commercial support and maintenance services. We manage the release of [[= product_name =]] using an agile iterative process and a continuous software development model, which is why we provide two kinds of [[= product_name =]] releases: -- Long Term Support releases (LTS) which are supported by Ibexa for a long period of time. +- Long Term Support releases (LTS) which are supported by [[= product_name_base =]] for a long period of time. - Fast Track releases (FT) give access to the latest features and are supported for a short period of time. They are maintained only until the next FT release is introduced. FT releases are tailored for those who want to stay up-to-date with newest functionalities, @@ -37,7 +37,7 @@ The version number of [[= product_name =]] and all its internal components follo Distribution files of our three editions are as follows: -- for [[= product_name_content =]]: ibexa-content-vX.Y.Z.tgz +- for [[= product_name_headless =]]: ibexa-headless-vX.Y.Z.tgz - for [[= product_name_exp =]]: ibexa-experience-vX.Y.Z.tgz - for [[= product_name_com =]]: ibexa-commerce-vX.Y.Z.tgz diff --git a/docs/search/search_engines/solr_search_engine/configure_solr.md b/docs/search/search_engines/solr_search_engine/configure_solr.md index c6bd63bab9..08482c4f35 100644 --- a/docs/search/search_engines/solr_search_engine/configure_solr.md +++ b/docs/search/search_engines/solr_search_engine/configure_solr.md @@ -226,7 +226,7 @@ Connect to the Solr slave interface (http://localhost:8983/solr), go to your cor # Configure HTTP Client for Solr queries -Ibexa Solr Bundle uses Symfony HTTP Client to fetch and update Solr index. +[[= product_name_base =]] Solr Bundle uses Symfony HTTP Client to fetch and update Solr index. You can configure timeout and maximum number of retries for that client using Solr Bundle's Semantic configuration: ```yaml diff --git a/docs/search/search_engines/solr_search_engine/solr_overview.md b/docs/search/search_engines/solr_search_engine/solr_overview.md index 42e8244d9a..f808f42a0f 100644 --- a/docs/search/search_engines/solr_search_engine/solr_overview.md +++ b/docs/search/search_engines/solr_search_engine/solr_overview.md @@ -10,4 +10,4 @@ When you enable Solr and re-index your content, all your existing Search queries This allows you to scale up your [[= product_name =]] installation and be able to continue development locally against SQL engine, and have a test infrastructure, Staging and Prod powered by Solr. By this, it also removes considerable load from your database. -For further information on the architecture of Ibexa DXP, see [Architecture](architecture.md). \ No newline at end of file +For further information on the architecture of [[= product_name =]], see [Architecture](architecture.md). \ No newline at end of file diff --git a/docs/tutorials/beginner_tutorial/beginner_tutorial.md b/docs/tutorials/beginner_tutorial/beginner_tutorial.md index 3332036367..214293f29e 100644 --- a/docs/tutorials/beginner_tutorial/beginner_tutorial.md +++ b/docs/tutorials/beginner_tutorial/beginner_tutorial.md @@ -6,7 +6,7 @@ description: Go through a beginner tutorial which presents the Ibexa DXP content This tutorial is a step-by-step guide to building an [[= product_name =]] website. -You can use it with both [[= product_name_content =]] and [[= product_name_exp =]]. +You can use it with both [[= product_name_headless =]] and [[= product_name_exp =]]. ## Intended audience diff --git a/docs/update_and_migration/from_2.5/to_3.3.latest.md b/docs/update_and_migration/from_2.5/to_3.3.latest.md index 4570915c1c..8e876f1ae4 100644 --- a/docs/update_and_migration/from_2.5/to_3.3.latest.md +++ b/docs/update_and_migration/from_2.5/to_3.3.latest.md @@ -160,7 +160,7 @@ Run the following scripts: #### VCL configuration for Fastly -Ibexa DXP now supports Fastly shielding. If you are using Fastly and want to use shielding, you need to update your VCL files. +[[= product_name =]] now supports Fastly shielding. If you are using Fastly and want to use shielding, you need to update your VCL files. !!! tip diff --git a/docs/update_and_migration/from_2.5/to_3.3.md b/docs/update_and_migration/from_2.5/to_3.3.md index 1d1b49b3ef..d8424996ab 100644 --- a/docs/update_and_migration/from_2.5/to_3.3.md +++ b/docs/update_and_migration/from_2.5/to_3.3.md @@ -10,12 +10,12 @@ Before you start this procedure, make sure you have completed the previous step, ## 5. Update to v3.3 -Ibexa DXP v3.3 uses [Symfony Flex]([[= symfony_doc =]]/quick_tour/flex_recipes.html). +[[= product_name =]] v3.3 uses [Symfony Flex]([[= symfony_doc =]]/quick_tour/flex_recipes.html). When updating from v3.2 to v3.3, you need to follow a special update procedure. !!! note - Ibexa DXP v3.3 requires Composer 2.0.13 or higher. + [[= product_name =]] v3.3 requires Composer 2.0.13 or higher. First, create an update branch `update-[[=target_version=]]` in git and commit your work. @@ -89,7 +89,7 @@ Resolve the conflicts in the following way: !!! caution It is impossible to update an Enterprise edition (`ezsystems/ezplatform-ee`) - to an Ibexa Content edition. + to an [[= product_name_content =]] edition. ### B. Update the app diff --git a/docs/update_and_migration/from_3.3/to_4.0.md b/docs/update_and_migration/from_3.3/to_4.0.md index ced06bbe90..38cc26f4ee 100644 --- a/docs/update_and_migration/from_3.3/to_4.0.md +++ b/docs/update_and_migration/from_3.3/to_4.0.md @@ -121,7 +121,7 @@ Apply the following database update script: ### Ibexa Open Source -If you have no access to Ibexa DXP's `ibexa/installer` package, apply the following database upgrade script: +If you have no access to [[= product_name =]]'s `ibexa/installer` package, apply the following database upgrade script: === "MySQL" ``` sql diff --git a/docs/update_and_migration/from_3.3/update_from_3.3.md b/docs/update_and_migration/from_3.3/update_from_3.3.md index b0e0573175..9162fcd205 100644 --- a/docs/update_and_migration/from_3.3/update_from_3.3.md +++ b/docs/update_and_migration/from_3.3/update_from_3.3.md @@ -229,7 +229,7 @@ Run the following scripts: ### Ibexa Open Source -If you have no access to Ibexa DXP's `ibexa/installer` package, apply the following database upgrade script: +If you have no access to [[= product_name =]]'s `ibexa/installer` package, apply the following database upgrade script: === "MySQL" diff --git a/docs/update_and_migration/from_4.0/to_4.1.md b/docs/update_and_migration/from_4.0/to_4.1.md index 1c7080c8c2..86d37416fa 100644 --- a/docs/update_and_migration/from_4.0/to_4.1.md +++ b/docs/update_and_migration/from_4.0/to_4.1.md @@ -117,7 +117,7 @@ Apply the following database update scripts: #### Ibexa Open Source -If you are using Ibexa OSS and have no access to Ibexa DXP's `ibexa/installer` package, database upgrade is not necessary. +If you are using [[= product_name_oss =]] and have no access to [[= product_name =]]'s `ibexa/installer` package, database upgrade is not necessary. ## Update the app to latest version of v4.1 diff --git a/docs/update_and_migration/from_4.1/update_from_4.1.md b/docs/update_and_migration/from_4.1/update_from_4.1.md index d1cfe5d7ed..b8ffd24591 100644 --- a/docs/update_and_migration/from_4.1/update_from_4.1.md +++ b/docs/update_and_migration/from_4.1/update_from_4.1.md @@ -127,7 +127,7 @@ Apply the following database update scripts: #### Ibexa Open Source -If you have no access to Ibexa DXP's `ibexa/installer` package, database upgrade is not necessary. +If you have no access to [[= product_name =]]'s `ibexa/installer` package, database upgrade is not necessary. ## Ensure password safety diff --git a/docs/update_and_migration/from_4.2/update_from_4.2.md b/docs/update_and_migration/from_4.2/update_from_4.2.md index 45b80bf0b9..de53636ada 100644 --- a/docs/update_and_migration/from_4.2/update_from_4.2.md +++ b/docs/update_and_migration/from_4.2/update_from_4.2.md @@ -142,7 +142,7 @@ Apply the following database update scripts: #### Ibexa Open Source -If you have no access to Ibexa DXP's `ibexa/installer` package, database upgrade is not necessary. +If you have no access to [[= product_name =]]'s `ibexa/installer` package, database upgrade is not necessary. ## Ensure password safety diff --git a/docs/update_and_migration/from_4.3/update_from_4.3.md b/docs/update_and_migration/from_4.3/update_from_4.3.md index 3672663d03..8bcdc94a8b 100644 --- a/docs/update_and_migration/from_4.3/update_from_4.3.md +++ b/docs/update_and_migration/from_4.3/update_from_4.3.md @@ -6,7 +6,7 @@ description: Update your installation to the latest v4.4 version from v4.3.x. This update procedure applies if you are using the newest v4.3 installation. -This release deprecates all Commerce packages in Ibexa DXP. They will be removed in v5. +This release deprecates all Commerce packages in[[= product_name =]]. They will be removed in v5. Until that time, they will be maintained by Ibexa with fixes, including security fixes, but they won't be further developed. Old packages are replaced by [the all-new Ibexa Commerce packages](ibexa_dxp_v4.4.md#all-new-ibexa-commerce-packages). diff --git a/docs/update_and_migration/from_4.4/update_from_4.4.md b/docs/update_and_migration/from_4.4/update_from_4.4.md index 03f2d08519..23489eedda 100644 --- a/docs/update_and_migration/from_4.4/update_from_4.4.md +++ b/docs/update_and_migration/from_4.4/update_from_4.4.md @@ -106,7 +106,7 @@ php bin/console ibexa:migrate:richtext-namespaces #### Ibexa Open Source -If you have no access to Ibexa DXP's `ibexa/installer` package, apply the following database update: +If you have no access to [[= product_name =]]'s `ibexa/installer` package, apply the following database update: === "MySQL" diff --git a/mkdocs.yml b/mkdocs.yml index 1affb12dd1..0546b4b1cb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -814,10 +814,16 @@ extra: url: '/projects/connect' # Global variables site_display_name: 'Ibexa Documentation' + product_name_base: 'Ibexa' product_name: 'Ibexa DXP' - product_name_content: 'Ibexa Headless' + product_name_content: 'Ibexa Content' + product_name_headless: 'Ibexa Headless' product_name_exp: 'Ibexa Experience' product_name_com: 'Ibexa Commerce' + product_name_cdp: 'Ibexa CDP' + product_name_connect: 'Ibexa Connect' + product_name_cloud: 'Ibexa Cloud' + product_name_oss: 'Ibexa OSS' # Global variables - latest tag versions latest_tag_2_5: '2.5.31' latest_tag_3_3: '3.3.35'