Skip to content
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
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ Full list of options:
|`afterDragOver`|Callback function invoked after moving onto a droppable element.|optional|
|`afterDrop`|Callback function invoked after dropping an element.|optional|
|`attachCustomEventHandlersToItem`|Function to be invoked while attaching event handlers to every item in the item's container. Item of `HTMLElement` type is passed to the function as the first param.|optional|
|`timeoutRemovePlaceholders`|The amount of time after which the not dropped item disappears.The default vaule is set to 500ms.|optional|
|`timeoutRemovePlaceholders`|The amount of time after which the not dropped item disappears.The default value is set to 500ms.|optional|
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ ibexa:

The following subset of the [ICU date and time formats](https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/classSimpleDateFormat.html#details) is allowed:

<!-- vale Ibexa.Spellcheck = NO -->

|Symbol|Meaning|
|---|---|
|y, yy, yyyy, Y, YY, YYYY|year|
Expand Down
4 changes: 2 additions & 2 deletions docs/administration/back_office/browser/add_browser_tab.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,9 @@ Ensure that the new tab is styled by adding the following files to `assets/css/`
[[= include_file('code_samples/back_office/udw/assets/css/image.css') =]]
```

### Add css to webpack
### Add CSS to webpack

Finally, add css in `webpack.config.js`:
Finally, add CSS in `webpack.config.js`:

```js
ibexaConfigManager.add({
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/back_office/content_tab_switcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ ibexa:
```


The `meta_field_groups_list` configuration can be overriden.
The `meta_field_groups_list` configuration can be overridden.

## Add custom tab

Expand Down
4 changes: 2 additions & 2 deletions docs/administration/dashboard/configure_default_dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ All the settings in the configuration are reflected in the back office.

## Container remote ID

Defines starting location container for all the dashboards, including customized and predifined ones.
Defines starting location container for all the dashboards, including customized and predefined ones.
You can see it in the **Admin** panel, **Dashboards** section, **Dashboards** folder in the content tree.
In the **Technical details** tab, it is defined as **Location remote ID**.

Expand Down Expand Up @@ -63,7 +63,7 @@ Specifies the name of the [Section](sections.md).
## Content type identifier

It is an identifier that represents dashboard content type.
You can find it in the **Admin** panel, **Dashboard content Ttpe** section, **View/Global properties** tab.
You can find it in the **Admin** panel, **Dashboard content Type** section, **View/Global properties** tab.

![Content type identifier](dashboard_content_type_identifier.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/api/php_api/php_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@

You can access the PHP API by injecting relevant services into your code:

- By using [auto-wiring]([[= symfony_doc =]]/service_container/autowiring.html), and the service classname in the `Ibexa\Contracts` namespace (see `bin/console debug:autowiring | grep Ibexa.Contracts`).
- By using [auto-wiring]([[= symfony_doc =]]/service_container/autowiring.html), and the service class name in the `Ibexa\Contracts` namespace (see `bin/console debug:autowiring | grep Ibexa.Contracts`).

Check failure on line 49 in docs/api/php_api/php_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/php_api/php_api.md#L49

[Ibexa.Lists] Do not put fullstops at the end of bullets
Raw output
{"message": "[Ibexa.Lists] Do not put fullstops at the end of bullets", "location": {"path": "docs/api/php_api/php_api.md", "range": {"start": {"line": 49, "column": 74}}}, "severity": "ERROR"}
- By using [service parameters]([[= symfony_doc =]]/service_container.html#service-parameters), and service aliases (see `bin/console debug:autowiring | grep ibexa.api`).
- By using the repository's `get[ServiceName]()` methods, for example, [`Repository::getContentService()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Repository.html#method_getContentService), or [`getUserService()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Repository.html#method_getUserService).
(Prefer injecting several Repository's dedicated services instead of the whole Repository if the Repository itself isn't needed.)
Expand Down
2 changes: 1 addition & 1 deletion docs/cdp/cdp_activation/cdp_data_export.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Now, you can go to the **File mapping** section.

## File mapping

Mapping is completed automatically, the system fills all required information and shows available columns with datapoints on the right.
Mapping is completed automatically, the system fills all required information and shows available columns with data points on the right.
You can change their names if needed or disallow empty fields by checking **Mandatory**.
If the provided file contains empty values, this option isn't available.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If this extensive list of variables isn't sufficient, you can [extend it to incl
| |billingAddressPhoneNumber|Phone number|123456789|
|Payment|paymentMethodIdentifier|Technical identifier of payment method| | |
| |paymentMethodName|Human readable name of payment method| | |
| |paymentMethodDescription|Human readable description of payment method|Prepaid cards and gift cards (offline ver.)| |
| |paymentMethodDescription|Human readable description of payment method|Prepaid cards and gift cards (offline version)| |
| |paymentMethodTypeName|Human readable name of payment method type|Offline| |
| |paymentStatus|Technical identifier of payment status|pending, failed|Only available in PaymentStatusChange notification|
|Shipment|shippingMethodIdentifier|Technical identifier of shipping method| | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

Users can invite both internal and external collaborators to a session, giving them access for editing or previewing.

Additionaly, they can collaborate using a Real-time collaboration, an advanced part of the collaboration feature, to write and review content in a live mode thanks to CKEditor.
Additionally, they can collaborate using a Real-time collaboration, an advanced part of the collaboration feature, to write and review content in a live mode thanks to CKEditor.

Check warning on line 13 in docs/content_management/collaborative_editing/collaborative_editing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/collaborative_editing/collaborative_editing.md#L13

[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.
Raw output
{"message": "[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.", "location": {"path": "docs/content_management/collaborative_editing/collaborative_editing.md", "range": {"start": {"line": 13, "column": 1}}}, "severity": "WARNING"}
Real-time collaboration syncs changes instantly and shows user avatars and colored tags to indicate who is editing specific part of the Rich Text field.

This feature also introduces new dashboard tabs for managing shared drafts and joining collaboration sessions easily.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ To add the real-time editing capabilities, continue with the instruction below.

## Configure real-time editing

You must have an arrangment with [[= product_name_base =]] before configuring the real-time editing.
You must have an arrangement with [[= product_name_base =]] before configuring the real-time editing.
If you haven't already, you must also accept the Terms of Service in the [Service portal](https://support.ibexa.co/).

Only then you can create a new Collaborative editing environment.
Expand Down
6 changes: 3 additions & 3 deletions docs/content_management/content_api/managing_content.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,9 +171,9 @@
You can find content types that match specific criteria by using the [`ContentTypeService::findContentTypes()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-ContentTypeService.html#method_findContentTypes) method.
This method accepts a `ContentTypeQuery` object that supports filtering and sorting by IDs, identifiers, group membership, and other criteria.

!!! note "Criterions, sort clauses and REST APIs"
!!! note "Criteria, sort clauses and REST APIs"

Check failure on line 174 in docs/content_management/content_api/managing_content.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/content_api/managing_content.md#L174

[Ibexa.DomainTermCapitalization] Use 'Sort Clause(s)' instead of 'sort clauses'
Raw output
{"message": "[Ibexa.DomainTermCapitalization] Use 'Sort Clause(s)' instead of 'sort clauses'", "location": {"path": "docs/content_management/content_api/managing_content.md", "range": {"start": {"line": 174, "column": 21}}}, "severity": "ERROR"}

For a full list of available criterions and sort clauses that you can use when finding and filtering content types, see [Content Type Search Criteria](content_type_criteria.md) and [Content Type Search Sort Clauses](content_type_sort_clauses.md) references.
For a full list of available criteria and sort clauses that you can use when finding and filtering content types, see [Content Type Search Criteria](content_type_criteria.md) and [Content Type Search Sort Clauses](content_type_sort_clauses.md) references.

For the REST API, see [Filter content types](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Type/operation/api_contenttypesview_post).

Expand All @@ -187,7 +187,7 @@

When constructing a `ContentTypeQuery`, you can pass the following parameters:

- `?CriterionInterface $criterion = null` — a filter to apply (use one or a combination of the criterions above)
- `?CriterionInterface $criterion = null` — a filter to apply (use one or a combination of the criteria above)

- `array $sortClauses = []` — list of sort clauses to order the results

Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/field_types/field_type_search.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ The default available search field types that can be found in the `Ibexa\Contrac
|`FloatField`|Field for floating point numbers.|
|`FullTextField`|Represents full text searchable value of the field which can be indexed by the legacy search engine. Some full text fields are stored as an array of strings.|
|`GeoLocationField`|Field used for Geo location.|
|`IdentifierField`|Field used for IDs. Basically acts like the string field, but it's not queried by fulltext searches|
|`IdentifierField`|Field used for IDs. Basically acts like the string field, but it's not queried by full-text searches|
|`IntegerField`|Field for integer numbers.|
|`MultipleBooleanField`|Multiple boolean values.|
|`MultipleIdentifierField`|Multiple IDs values.|
Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/images/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ If you use other formats, such a PNG, SVG, GIF, or WEBP, and you use the Image E
|Image format|Library|
|---|---|
|JPEG|JpegOptim|
|PNG|Either Optipng or Pngquant 2|
|PNG|Either OptiPNG or Pngquant 2|
|SVG|SVGO 1|
|GIF|Gifsicle|
|WEBP|cwebp|
Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/locations.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Every published content item has a location and, as a consequence, also a place

A content item receives a location only once it has been published.
This means that a new unpublished draft doesn't have a location yet.
You can find drats in the **Drafts** tab in the **Content** menu.
You can find drafts in the **Drafts** tab in the **Content** menu.

![Drafts](content_management_drafts.png "Drafts")

Expand Down
4 changes: 2 additions & 2 deletions docs/content_management/pages/page_builder_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,14 +202,14 @@ One of the most important tools that Page Builder offers, is a Scheduler. It all

Page Builder allows you to create highly customizable websites. You can build modifiable and targeted landing pages that meet your needs.
Each dynamic blocks has its own settings, properties and design that you can set up in your way to customize the content appearing on the page.
Additionaly, if you feel comfortable with your technical skills, you can configure your own elements, for example, a new customized layout, or block.
Additionally, if you feel comfortable with your technical skills, you can configure your own elements, for example, a new customized layout, or block.

### Increase sales with highly personalized campaigns

Personalized campaigns are one of the factors that can increase your sales.
With Page Builder you can achieve it, by using customization and time Scheduler.
Anytime you can edit your page and change a position of a block to enhance visibility.
Additionaly, Page Builder offers you a selection of ready-to-use page blocks that can help you to create content tailored to each individual customer:
Additionally, Page Builder offers you a selection of ready-to-use page blocks that can help you to create content tailored to each individual customer:

A. **Default** blocks:

Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started/install_ibexa_dxp.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ Run the post-installation script with the following command:
composer run post-install-cmd
```

## Use PHPs built-in server
## Use PHP's built-in server

For development you can use the built-in PHP server.

Expand Down
4 changes: 2 additions & 2 deletions docs/getting_started/install_with_ddev.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ To use MySQL instead, run the following command:
ddev config --database=mysql:8.4
```

You can also use other versions of MariaDB, Mysql or PostgreSQL.
You can also use other versions of MariaDB, MySQL or PostgreSQL.
See [DDEV database types documentation](https://ddev.readthedocs.io/en/latest/users/extend/database-types/) for available version ranges.

#### Configure database connection
Expand Down Expand Up @@ -366,7 +366,7 @@ To run an existing project, you need to:
1. Add Composer authentication.
1. Install dependencies packages with Composer.
1. Populate the contents, which could mean:
- getting a clean database with ddev `php bin/console ibexa:install` and adding some data with [Ibexa data migration](importing_data.md), or
- getting a clean database with `ddev php bin/console ibexa:install` and adding some data with [Ibexa data migration](importing_data.md), or
- injecting a dump with [`ddev import-db`](https://ddev.readthedocs.io/en/latest/users/usage/commands/#import-db) and copying related binary files into `public/var`.

The following examples run an already [version-controlled project](install_ibexa_dxp.md#add-project-to-version-control) and have the right content structure (but no content):
Expand Down
8 changes: 4 additions & 4 deletions docs/ibexa_cloud/ibexa_cloud_guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Learn how to host your application and improve your business processess by using Ibexa Cloud hosting platform.
description: Learn how to host your application and improve your business processes by using Ibexa Cloud hosting platform.

Check failure on line 2 in docs/ibexa_cloud/ibexa_cloud_guide.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ibexa_cloud/ibexa_cloud_guide.md#L2

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/ibexa_cloud/ibexa_cloud_guide.md", "range": {"start": {"line": 2, "column": 94}}}, "severity": "ERROR"}
title: Ibexa Cloud product guide
month_change: false
---
Expand Down Expand Up @@ -87,10 +87,10 @@
[[= product_name_cloud =]] is compatible with your choice of public cloud server and supports a variety of hosting platforms.
It's a Git-native development - compatible with Git Flow.
[[= product_name_cloud =]] deployment integrates naturally at the end of your existing production chain, including staging, and work in progress branch preview.
You can also integrate with, for example, Bitbucket, GitHub, Gitlab.
You can also integrate with, for example, Bitbucket, GitHub, GitLab.
You can instantly clone every branch of both your code and infrastructure configuration.
Platform.sh (and [[= product_name_cloud =]], by extension) uses the [Infrastracture as Code approach](https://docs.platform.sh/learn/overview.html#infrastructure-as-code).
It means that the infrastracture is described in the code and that is what allows you to clone both code and infrastracture configuration at the same time.
Platform.sh (and [[= product_name_cloud =]], by extension) uses the [Infrastructure as Code approach](https://docs.platform.sh/learn/overview.html#infrastructure-as-code).
It means that the infrastructure is described in the code and that is what allows you to clone both code and infrastructure configuration at the same time.
If you want to work with services such as [MySQL](https://docs.platform.sh/add-services/mysql.html) or [Elasticsearch](https://docs.platform.sh/add-services/elasticsearch.html), you can add them with a line of code.
What's more, you can run in your chosen cloud, like Microsoft Azure, Orange, or Google Cloud Platform.

Expand Down
2 changes: 1 addition & 1 deletion docs/ibexa_products/ibexa_commerce.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ It contains default UI components and widgets that can be modified to [create a

Search becomes crucial when your product catalog is extensive.
Products can be sorted according to a variety of criteria using faceted search.
The value it brings makes it a vital component in merchandizing.
The value it brings makes it a vital component in merchandising.
You can set up your search engine using [[= product_name_com =]] to help clients find what they're looking for more easily, which could result in more purchases.

#### Catalog management
Expand Down
2 changes: 1 addition & 1 deletion docs/ibexa_products/ibexa_experience.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Before you start building a page, you also need to select a layout. It has a sig
[Form Builder](form_builder_guide.md) is an intuitive tool that allows you to transform user engagement on your website.
With this tool, you can design, deploy, and manage online forms quickly.
You can create a variety of forms that consist of different fields, including sign-up forms, surveys, or questionnaires.
Additionaly, you can monitor and manage the information obtained from website visitors and adjust your forms if needed.
Additionally, you can monitor and manage the information obtained from website visitors and adjust your forms if needed.

![Form Builder](form_builder.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/ibexa_products/ibexa_headless.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ For performance, several bricks can be added to your stack such as a reverse pro

By using a version control system and environment variables, you can deploy your configuration and extensions on several environments including [[= product_name_cloud =]].

Standard web APIs and [[[= product_name_connect =]]]([[= connect_doc =]]/general/ibexa_connect/) help establish interoperability, even if you'ren't an advanced developer.
Standard web APIs and [[[= product_name_connect =]]]([[= connect_doc =]]/general/ibexa_connect/) help establish interoperability, even if you aren't an advanced developer.

![Ibexa Headless data inputs and outputs](img/headless.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ All supported reverse proxies are content-aware.

## Cache tags

Understanding tags is the key to making the most ofIbexa's HTTP cache.
Understanding tags is the key to making the most of [[= product_name =]]'s HTTP cache.

Tags form a secondary set of keys assigned to every cache item, on top of the "primary key" which is the URI.
Like an index in a database, a tag is typically used for anything relevant that represents the given cache item.
Expand Down Expand Up @@ -150,7 +150,7 @@ For tagging needs in controllers, there are several options, here presented in r

1\. Reusing `DispatcherTagger` to pick correct tags.

Examples for tagging everything needed for content using the autowirable `ResponseTagger` interface:
Examples for tagging everything needed for content using the autowireable `ResponseTagger` interface:

``` php
/** @var \Ibexa\Contracts\HttpCache\ResponseTagger\ResponseTagger $responseTagger */
Expand Down Expand Up @@ -352,7 +352,7 @@ bin/console fos:httpcache:invalidate:tag ez-all

It's important to test your code in an environment which is as similar as your production environment as possible.
That means that if only are testing locally using the default Symfony Reverse proxy when your are going to use Varnish or Fastly in production, you're likely ending up some (bad) surprises.
Due to the symfony reverse proxy's lack of support for ESIs, it behaves quite different from Varnish and Fastly in some aspects.
Due to the Symfony reverse proxy's lack of support for ESIs, it behaves quite different from Varnish and Fastly in some aspects.
If you're going to use Varnish in production, make sure you also test your code with Varnish.
If you're going to use Fastly in production, testing with Fastly in your developer install is likely not feasible (you're local development environment must then be accessible for Fastly).
Testing with Varnish instead in most cases does the job.
Expand Down Expand Up @@ -501,7 +501,7 @@ So back to the original problem here.
This resource is for some reason not cached by Fastly (remember the `x-cache: MISS` we started with).
But origin says this page can be cached for 1 day.
How can that be?
The likely reason is that this page also contains some ESI fragments and that one or more of these aren't cachable.
The likely reason is that this page also contains some ESI fragments and that one or more of these aren't cacheable.

So, first let's see if there are any ESIs here.
We remove the `-IXGET` options (to see content of the response, not only headers) to curl and search for esi:
Expand Down Expand Up @@ -592,7 +592,7 @@ ESI headers are only seen by the HTTP cache.
- Symfony reverse proxy doesn't support ESIs at all, and any ESI calls (`render_esi()`) are implicitly replaced by sub-requests (`render()`).
So any `Set-Cookie` **is** sent to the client when using Symfony reverse proxy.

- Fastly flags it resource as "not cachable" because it set a cookie at least once.
- Fastly flags it resource as "not cacheable" because it set a cookie at least once.
Even though that endpoint stops setting cookies, Fastly still doesn't cache that fragment.
Any document referring to that ESI is a `MISS`.
Fastly cache needs to be purged (`Purge-all` request) to remove this flag.
Expand Down
Loading
Loading