Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IBX-6618: Updated global variables #2154

Merged
merged 4 commits into from
Oct 12, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- vale off -->

# Ibexa DXP Developer Documentation

This repository is the source for the [developer documentation for Ibexa](https://doc.ibexa.co/en/latest),
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/project_organization/bundles.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
4 changes: 2 additions & 2 deletions docs/api/rest_api/rest_api_usage/testing_rest_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Open a PHP shell in a terminal with <nobr>`php -a`</nobr> 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)

Expand Down Expand Up @@ -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.
6 changes: 3 additions & 3 deletions docs/cdp/cdp.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@

## 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.

Check warning on line 11 in docs/cdp/cdp.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/cdp.md#L11

[Ibexa.FutureTense] Use present tense instead of future.
Raw output
{"message": "[Ibexa.FutureTense] Use present tense instead of future.", "location": {"path": "docs/cdp/cdp.md", "range": {"start": {"line": 11, "column": 35}}}, "severity": "WARNING"}
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.
Expand Down
20 changes: 10 additions & 10 deletions docs/cdp/cdp_activation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Configuration

To configure Ibexa CDP, use the `ibexa.system.<scope>.cdp` [configuration key](configuration.md#configuration-files):
To configure [[= product_name_cdp =]], use the `ibexa.system.<scope>.cdp` [configuration key](configuration.md#configuration-files):

```yaml
ibexa:
Expand All @@ -27,12 +27,12 @@
```

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 =]].

Check warning on line 35 in docs/cdp/cdp_activation.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/cdp_activation.md#L35

[Ibexa.FutureTense] Use present tense instead of future.
Raw output
{"message": "[Ibexa.FutureTense] Use present tense instead of future.", "location": {"path": "docs/cdp/cdp_activation.md", "range": {"start": {"line": 35, "column": 4}}}, "severity": "WARNING"}
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.
Expand All @@ -41,14 +41,14 @@

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)

Expand All @@ -58,7 +58,7 @@

## 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.

Check warning on line 61 in docs/cdp/cdp_activation.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/cdp_activation.md#L61

[Ibexa.FutureTense] Use present tense instead of future.
Raw output
{"message": "[Ibexa.FutureTense] Use present tense instead of future.", "location": {"path": "docs/cdp/cdp_activation.md", "range": {"start": {"line": 61, "column": 77}}}, "severity": "WARNING"}
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.

Expand Down Expand Up @@ -86,7 +86,7 @@
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.

Expand Down Expand Up @@ -149,7 +149,7 @@

## 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.

Expand All @@ -162,7 +162,7 @@

- **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.

Check warning on line 165 in docs/cdp/cdp_activation.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/cdp_activation.md#L165

[Ibexa.FutureTense] Use present tense instead of future.
Raw output
{"message": "[Ibexa.FutureTense] Use present tense instead of future.", "location": {"path": "docs/cdp/cdp_activation.md", "range": {"start": {"line": 165, "column": 148}}}, "severity": "WARNING"}
- **Base URL** - URL of your instance with added `/cdp/webhook` at the end.

![Ibexa Information - Activation](img/cdp_activation_ibexa_info.png)
Expand Down
12 changes: 6 additions & 6 deletions docs/cdp/cdp_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@

# 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 =]].

Check warning on line 13 in docs/cdp/cdp_installation.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/cdp_installation.md#L13

[Ibexa.FutureTense] Use present tense instead of future.
Raw output
{"message": "[Ibexa.FutureTense] Use present tense instead of future.", "location": {"path": "docs/cdp/cdp_installation.md", "range": {"start": {"line": 13, "column": 6}}}, "severity": "WARNING"}
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:

Expand All @@ -36,5 +36,5 @@
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.
2 changes: 1 addition & 1 deletion docs/content_management/content_management_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/data_migration/data_migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/data_migration/exporting_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/forms/form_builder_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
18 changes: 9 additions & 9 deletions docs/content_management/pages/ibexa_connect_scenario_block.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
Expand All @@ -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)
4 changes: 2 additions & 2 deletions docs/content_management/url_management/url_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<?php

Expand Down
6 changes: 3 additions & 3 deletions docs/customer_management/customer_portal.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ invite and view members, check their order history and more.

## Availability

Customer Portal is available in Ibexa Experience. It is also compatible with PIM, Commerce and Ibexa Connect.
Customer Portal is available in [[= product_name_exp =]]. It is also compatible with PIM, Commerce and [[= product_name_connect =]].

## How does Customer Portal work?

Expand Down Expand Up @@ -129,7 +129,7 @@ If built-in statuses are not sufficient, you can add custom ones. You can also e

### REST API

Customer Portal comes with [REST API](https://doc.ibexa.co/en/latest/api/rest_api/rest_api_reference/rest_api_reference.html#corporate-account) for interacting with corporate accounts from the context of the Ibexa Connect app.
Customer Portal comes with [REST API](https://doc.ibexa.co/en/latest/api/rest_api/rest_api_reference/rest_api_reference.html#corporate-account) for interacting with corporate accounts from the context of the [[= product_name_connect =]] app.

## Capabilities

Expand All @@ -143,7 +143,7 @@ By giving users power to manage their own accounts, you reduce the need for admi

Self-registration allows your customers to take control of their business accounts.
This not only improves customer satisfaction but also reduces the administrative burden on your team.
With the ability to integrate with Ibexa Connect you are able to fully automate the process.
With the ability to integrate with [[= product_name_connect =]] you are able to fully automate the process.

### Address book

Expand Down
12 changes: 6 additions & 6 deletions docs/getting_started/install_ibexa_dxp.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ description: Install Ibexa DXP on a Linux system and prepare your installation f
To install [[= product_name =]] for development on macOS or Windows,
see the [installation guide for macOS and Windows](install_on_mac_os_and_windows.md).

!!! note "Installing Ibexa OSS"
!!! note "Installing [[= product_name_oss =]]"

This installation guide details the steps to install Ibexa DXP for users who have a subscription agreement with Ibexa.
If you want to install Ibexa OSS, you do not need authentication tokens or an account on updates.ibexa.co,
This installation guide details the steps to install[[= product_name =]] for users who have a subscription agreement with [[= product_name_base =]].
If you want to install [[= product_name_oss =]], you do not need authentication tokens or an account on updates.ibexa.co,
but must adapt the steps shown here to the product edition and the `ibexa/oss-skeleton` repository.

## Prepare work environment
Expand Down Expand Up @@ -119,7 +119,7 @@ After this, when running Composer to get updates, you will be asked for a userna
To use Composer to instantly create a project in the current folder with all the dependencies,
run the following command:

=== "[[= product_name_content =]]"
=== "[[= product_name_headless =]]"

``` bash
composer create-project ibexa/headless-skeleton .
Expand All @@ -141,7 +141,7 @@ run the following command:

If you are using PHP 7.4 or 8.0, use a different set of commands:

=== "[[= product_name_content =]]"
=== "[[= product_name_headless =]]"

``` bash
composer create-project ibexa/headless-skeleton --no-install .
Expand Down Expand Up @@ -452,4 +452,4 @@ and use the generated secret.

## Ibexa Cloud

If you want to host your application on Ibexa Cloud, follow the [Install on Ibexa Cloud](install_on_ibexa_cloud.md) procedure.
If you want to host your application on [[= product_name_cloud =]], follow the [Install on Ibexa Cloud](install_on_ibexa_cloud.md) procedure.
Loading