Skip to content
Merged
Show file tree
Hide file tree
Changes from 28 commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
450f620
ibexa_dxp_v3.2.md: Fix link to REST JWT
adriendupuis Nov 13, 2024
53685e8
graphql_operations.md: Fix link to mutation doc
adriendupuis Feb 14, 2025
7089be6
mkdocs.yml: symfony.com/doc/5.4 → 5.x
adriendupuis Feb 14, 2025
e0b8ec2
php_api.md: [[= symfony_doc =]] syntax
adriendupuis Feb 14, 2025
c599670
rest_requests.md: Update Allow header doc
adriendupuis Feb 14, 2025
16597b3
testing_rest_api.md: remove tool reco
adriendupuis Feb 14, 2025
2626781
reorder.md: Fix "Merge carts" link
adriendupuis Feb 14, 2025
0bed70e
enable_paypal_payments.md: update link
adriendupuis Feb 14, 2025
e4796a5
payum_integration.md: update link
adriendupuis Feb 14, 2025
91de62c
transactional_emails.md: update links
adriendupuis Feb 14, 2025
0543840
importing_data.md: update links
adriendupuis Feb 14, 2025
984d6a7
fastly_io.md: developer.fastly.com/learning → www.fastly.com/document…
adriendupuis Feb 14, 2025
a71b1e1
install_ibexa_dxp.md: Update how-to-install-lamp-stack-on-ubuntu link
adriendupuis Feb 14, 2025
53b0c9e
install_with_ddev.md: Update get-docker
adriendupuis Feb 14, 2025
68957d6
install_ibexa_dxp.md: Update link to prod HTTP server
adriendupuis Feb 14, 2025
caba85b
requirements.md: Update Redis doc links
adriendupuis Feb 14, 2025
ae81ecc
ibexa_commerce.md: Fix anchor link syntax `##`→`#`
adriendupuis Feb 14, 2025
22c20e4
fastly.md: developer.fastly.com/reference → www.fastly.com/documentat…
adriendupuis Feb 14, 2025
2bc7231
reverse_proxy.md: developer.fastly.com/learning → www.fastly.com/docu…
adriendupuis Feb 14, 2025
7dbab5d
persistence_cache.md: Update redis doc links
adriendupuis Feb 14, 2025
ea8a2a6
persistence_cache.md: Update Google Cloud link
adriendupuis Feb 14, 2025
00a0880
clustering_with_ddev.md: Update jq homepage
adriendupuis Feb 14, 2025
7a9faa8
clustering_with_ddev.md: Update Redis doc links
adriendupuis Feb 14, 2025
559b699
sessions.md: Update Redis doc links
adriendupuis Feb 14, 2025
f1142ee
siteaccess_matching.md: rm PHP doc example anchor
adriendupuis Feb 14, 2025
89b9d51
install_elasticsearch.md: Update Docker overview link
adriendupuis Feb 14, 2025
b969c95
install_solr.md: Update Solr docs links
adriendupuis Feb 15, 2025
cd40779
date_twig_filters.md: update anchor
adriendupuis Feb 15, 2025
b2e72af
new_in_doc.md: Add trailing / to few links
adriendupuis Feb 17, 2025
f625465
new_in_doc.md: target latest instead of master
adriendupuis Feb 17, 2025
17fc408
Apply suggestions from code review
adriendupuis Feb 17, 2025
ed1de59
Merge branch 'master' into fix-links
adriendupuis Feb 19, 2025
4f2c17e
site_factory_configuration.md: Fix "assigning roles" link
adriendupuis Feb 19, 2025
011dd5f
site_factory_configuration.md: "assigning roles" link w/ [[= user_doc…
adriendupuis Feb 19, 2025
87f01d3
Merge branch 'master' into fix-links
adriendupuis Feb 19, 2025
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: 1 addition & 1 deletion docs/api/graphql/graphql_operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Use GraphQL operations to create, update, and delete content.

# GraphQL operations

Operations on content in GraphQL are performed by using [mutations](https://graphql.org/learn/queries/#mutations).
Operations on content in GraphQL are performed by using [mutations](https://graphql.org/learn/mutations/).
They include creating, updating, and deleting content items.

The schema contains two mutations per content type, for example, `createFolder`, and `updateFolder`.
Expand Down
4 changes: 2 additions & 2 deletions docs/api/php_api/php_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ The full list of available services covers:

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 [service parameters]([[=symfony_doc=]]/service_container.html#service-parameters), and service aliases (see `bin/console debug:autowiring | grep ibexa.api`).
- 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 [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()`](php_api_reference/classes/Ibexa-Contracts-Core-Repository-Repository.html#method_getContentService), or [`getUserService()`](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/api/rest_api/rest_api_usage/rest_requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Unsafe methods require a CSRF token if [session-based authentication](rest_api_a

Any REST API URI responds to an `OPTIONS` request.

The response contains an [`Allow` header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.7), which lists the methods accepted by the resource.
The response contains an [`Allow` header](https://www.rfc-editor.org/rfc/rfc9110.html#name-allow), which lists the methods accepted by the resource.

```shell
curl -IX OPTIONS https://api.example.com/api/ibexa/v2/content/objects/1
Expand Down
3 changes: 0 additions & 3 deletions docs/api/rest_api/rest_api_usage/testing_rest_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ Depending on how your browser understands XML, it either downloads the XML file,

The following examples show how to interrogate the REST API with cURL, PHP or JS.

To test further, you can use browser extensions, like [Advanced REST client for Chrome](https://chrome.google.com/webstore/detail/advanced-rest-client/hgmloofddffdnphfgcellkdfbfbjeloo) or [RESTClient for Firefox](https://addons.mozilla.org/en-US/firefox/addon/restclient/), or dedicated tools.
For command line users, [HTTPie](https://github.com/httpie/cli) is a good tool.

## CLI

For examples of using `curl`, refer to:
Expand Down
2 changes: 1 addition & 1 deletion docs/commerce/checkout/reorder.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,4 +125,4 @@ For more information on how to modify checkout, see [Checkout API documentation]
### Cart PHP API

Reorder also facilitates `Ibexa\Contracts\Cart\CartServiceInterface` interface `mergeCarts` method.
For more information on it, see [Cart API documentation](cart_api.md#merge-cart).
For more information on it, see [Cart API documentation](cart_api.md#merge-carts).
4 changes: 2 additions & 2 deletions docs/commerce/payment/enable_paypal_payments.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ edition: commerce

By using Payum to integrate PayPal into your application, you can offer your customers a versatile payment processing service that supports various payment methods, including credit cards, debit cards, Pay Later options, and alternative payment methods.

Before you can proceed with integrating PayPal, you must [create a PayPal business account](https://www.paypal.com/bizsignup/#/singlePageSignup) and obtain API credentials.
Before you can proceed with integrating PayPal, you must [create a PayPal business account](https://www.paypal.com/unifiedonboarding/entry) and obtain API credentials.

Install the PayPal package:

Expand Down Expand Up @@ -41,4 +41,4 @@ ibexa:
pp_express_checkout:
name: "Translated PayPal Express Checkout name"

```
```
2 changes: 1 addition & 1 deletion docs/commerce/payment/payum_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ edition: commerce

# Payum integration

[Payum](https://payum.gitbook.io/payum/) is a payment processing solution that simplifies the integration of various payment services like Stripe and PayPal into your application.
[Payum](https://payum.gitbook.io/payum) is a payment processing solution that simplifies the integration of various payment services like Stripe and PayPal into your application.
These services provide security of online transactions, and allow you to accept multiple payment methods while ensuring a seamless experience for the customers.
By configuring service gateways, mapping workflow actions and translating payment service names, you streamline the online payment process, and can offer a diverse payment experience.

Expand Down
6 changes: 3 additions & 3 deletions docs/commerce/transactional_emails/transactional_emails.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,13 @@ Flex installs and activates the package.

### Configure Actito integration

Before you can start configuring the notifier engine to process and dispatch notifications to be forwarded as transactional emails, you must first obtain and configure an [Actito license](lihttps://www.actito.com/en-BE/pricing/nk).
Before you can start configuring the notifier engine to process and dispatch notifications to be forwarded as transactional emails, you must first obtain and configure an [Actito license](https://www.actito.com/en-BE/pricing/nk).

Once you gain access to the Actito dashboard:

1\. Configure the API to make calls with the GET method.

2\. Get the [API key](https://cdn3.actito.com/fe/actito-documentation/docs/Managing_API_users) and entity name.
2\. Get the [API key](http://cdn3.actito.com/fe/actito-documentation/docs/Managing_API_users/) and entity name.

3\. Set these values in the YAML configuration files, under the `ibexa.system.default.connector_actito` key:

Expand All @@ -67,7 +67,7 @@ ibexa:
By default, a trigger message coming from [[= product_name =]] contains the following attributes with information about the end-user: name, surname, and email.

Those attributes can then be used to present statistics in the Actito dashboard.
If this set of attributes is insufficient for your needs, you can [add more attributes to the trigger message](extend_transactional_emails.md#customize-actito-end-user-profile-schema).
If this set of attributes is insufficient for your needs, you can [add more attributes to the trigger message](extend_transactional_emails.md#customize-actito-end-user-profile).

### Create email campaigns

Expand Down
4 changes: 2 additions & 2 deletions docs/content_management/data_migration/importing_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ In the example above, the expression is enclosed in `###` and the repeated strin

#### Generating fake data

You can also generate fake data with the help of [`FakerPHP`](https://fakerphp.github.io/).
You can also generate fake data with the help of [`FakerPHP`](https://fakerphp.org/).

To use it, first install Faker on your system:

Expand Down Expand Up @@ -377,7 +377,7 @@ The following example shows how to create variants for a product identified by i

#### Product assets

The following example creates an image [content item](#content-items) from a local image file, and then uses it as a product asset for a variant ([created in previous example](#product-variant)):
The following example creates an image [content item](#content-items) from a local image file, and then uses it as a product asset for a variant ([created in previous example](#product-variants)):

``` yaml
[[= include_file('code_samples/data_migration/examples/create_product_asset.yaml') =]]
Expand Down
9 changes: 4 additions & 5 deletions docs/content_management/images/fastly_io.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ To be able to configure this feature, you need [Fastly IO subscription](https://

To use Fastly Image Optimizer, you first need a [working setup of Ibexa DXP and Fastly](reverse_proxy.md#using-varnish-or-fastly)
with shielding enabled.
To enable shielding, follow the steps in [Fastly Developer Documentation](https://developer.fastly.com/learning/concepts/shielding/#enabling-and-disabling-shielding).
To enable shielding, follow the steps in [Fastly Developer Documentation](https://www.fastly.com/documentation/guides/concepts/shielding/#enabling-and-disabling-shielding).
Remember to choose a shield location from the **Shielding** menu, as described in [Fastly User Documentation](https://docs.fastly.com/en/guides/shielding#enabling-shielding).

## VCL configuration

To manipulate your Fastly VCL configuration directly from the command line,
you need to:

- [install Fastly CLI](https://developer.fastly.com/learning/tools/cli/#installing),
- [install Fastly CLI](https://www.fastly.com/documentation/reference/tools/cli/#installing),
- define `FASTLY_SERVICE_ID` and `FASTLY_KEY` environmental variables,
- set optimizer restrictions by using the `ibexa_image_optimizer.vcl` file:

Expand All @@ -36,7 +36,7 @@ if (req.url.ext ~ "(?i)^(gif|png|jpe?g|webp)$") {

You can customize what image formats are included, for example: `gif|png|jpe?g|webp`,
and which paths should be used as a source of images, for example: `^/var/([a-zA-Z0-9_-]+)/storage/images`.
For more configuration options, see [Enabling image optimization](https://developer.fastly.com/reference/io/#enabling-image-optimization).
For more configuration options, see [Enabling image optimization](https://www.fastly.com/documentation/reference/io/#enabling-image-optimization).

To apply your modifications or use the default configuration as-is, you can upload the `.vcl` file from the command line:

Expand Down Expand Up @@ -79,7 +79,7 @@ so it needs to be able to serve the same image variations.
Fastly IO image filters aren't compatible with [[= product_name_base =]] built-in filters,
so you aren't able to reflect your original filters accurately with Fastly.
The script below helps you find replacement filters within Fastly configuration for the basic filters.
For more optimization options on Fastly side, see [Fastly IO reference](https://developer.fastly.com/reference/io/).
For more optimization options on Fastly side, see [Fastly IO reference](https://www.fastly.com/documentation/reference/io/).

To generate your original image configuration run:

Expand Down Expand Up @@ -140,4 +140,3 @@ You can select defined image variations during content item creation in the imag
Variations can include different sizing options and other filters that are applied to the image.

![Fastly image variations](img/fastly_variations.png)

4 changes: 2 additions & 2 deletions docs/getting_started/install_ibexa_dxp.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ description: Install Ibexa DXP on a Linux system and prepare your installation f

To install [[= product_name =]] you need a stack with your operating system, MySQL or MariaDB, and PHP.

You can install it by following your favorite tutorial, for example: [Install LAMP stack on Ubuntu](https://www.digitalocean.com/community/tutorials/how-to-install-linux-apache-mysql-php-lamp-stack-ubuntu-18-04).
You can install it by following your favorite tutorial, for example: [Install LAMP stack on Ubuntu](https://www.digitalocean.com/community/tutorials/how-to-install-lamp-stack-on-ubuntu).

Additional requirements:

- [Node.js](https://nodejs.org/en) and [Yarn](https://classic.yarnpkg.com/en/docs/install/#debian-stable) for asset management
- `git` for version control

[For production](#prepare-installation-for-production) you also need Apache or nginx as the HTTP server (Apache is used as an example below).
For production, you need to [configure an HTTP server](#configure-an-http-server), Apache or nginx (Apache is used as an example below).

Before getting started, make sure you review other [requirements](requirements.md) to see the systems that is supported and used for testing.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started/install_with_ddev.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ DDEV is an open-source tool that simplifies the process of setting up local PHP

Before you start the installation, ensure that you have the following software installed:

- [Docker](https://docs.docker.com/get-docker/)
- [Docker](https://docs.docker.com/get-started/get-docker/)
- [DDEV](https://ddev.readthedocs.io/en/latest/users/install/ddev-installation/)

## Installation
Expand Down
4 changes: 2 additions & 2 deletions docs/getting_started/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
=== "[[= product_name =]] v4.6"

- Linux NFS or S3/EFS (for IO, aka binary files stored in content repository, not supported with legacy)
- Redis 4.0+, 5.0 or higher (separate instances for session and cache, both using a `volatile-*` [eviction policy](https://redis.io/docs/reference/eviction/), session instance configured for persistence) or [Memcached](https://memcached.org/) 1.5 or higher
- Redis 4.0+, 5.0 or higher (separate instances for session and cache, both using a `volatile-*` [eviction policy](https://redis.io/docs/latest/develop/reference/eviction/), session instance configured for persistence) or [Memcached](https://memcached.org/) 1.5 or higher
- [Varnish](http://varnish-cache.org/) 6.0LTS or 7.1 with [varnish-modules](https://github.com/varnish/varnish-modules/blob/master/README.md) or [Fastly](https://www.fastly.com/) using [the provided bundle](http_cache.md) (for HTTP Cache)

If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
Expand All @@ -218,7 +218,7 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
=== "[[= product_name =]] v3.3"

- Linux NFS or S3/EFS (for IO, aka binary files stored in content repository, not supported with legacy)
- Redis 4.0+, 5.0 or higher (separate instances for session and cache, both using a `volatile-*` [eviction policy](https://redis.io/docs/reference/eviction/), session instance configured for persistence) or [Memcached](https://memcached.org/) 1.5 or higher
- Redis 4.0+, 5.0 or higher (separate instances for session and cache, both using a `volatile-*` [eviction policy](https://redis.io/docs/latest/develop/reference/eviction/), session instance configured for persistence) or [Memcached](https://memcached.org/) 1.5 or higher
- [Varnish](http://varnish-cache.org/) 6.0LTS with [varnish-modules](https://github.com/varnish/varnish-modules/blob/master/README.md) or [Fastly](https://www.fastly.com/) using [the provided bundle](https://doc.ibexa.co/en/3.3/guide/cache/http_cache/#serving-varnish-through-fastly) (for HTTP Cache)

If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
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 @@ -90,7 +90,7 @@ You can set up your search engine using [[= product_name_com =]] to help clients

Commerce allows you to send transactional emails - messages that [[= product_name_base =]] can send through the [Actito](https://www.actito.com/en-BE/) gateway to your end-users.
These emails include notifications about changes in the status of various actions taken in relation to your commerce presence.
With this feature you can also [create email campaigns](transactional_emails.md##create-email-campaigns) to engage users and increase sales.
With this feature you can also [create email campaigns](transactional_emails.md#create-email-campaigns) to engage users and increase sales.

### Use cases

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Configure Fastly for use with Ibexa DXP.
# Configure and customize Fastly

You can configure Fastly by using API calls or through the Fastly Web Interface.
Fastly provides a [Fastly CLI](https://developer.fastly.com/reference/cli/) for configuring Fastly through its API.
Fastly provides a [Fastly CLI](https://www.fastly.com/documentation/reference/cli/) for configuring Fastly through its API.

[[= product_name_cloud =]] is delivered with Fastly preconfigured.
It means that you don't have to do any changes to the Fastly configuration to make your site work.
Expand Down Expand Up @@ -334,11 +334,11 @@ diff -ruN generated_vcl_11_json_done generated_vcl_12_json_done

## Enable basic-auth on Fastly

To enable basic-auth, use [Fastly documentation](https://developer.fastly.com/solutions/examples/http-basic-auth/) as an example.
To enable basic-auth, use [Fastly documentation](https://www.fastly.com/documentation/solutions/examples/http-basic-auth/) as an example.

Follow the steps below.

Usernames and passwords can be stored inside the VCL file, but in this case credentials are stored in a [dictionary](https://docs.fastly.com/en/guides/working-with-dictionaries-using-the-web-interface#working-with-dictionaries-using-vcl-snippets).
Usernames and passwords can be stored inside the VCL file, but in this case credentials are stored in a [dictionary](https://docs.fastly.com/en/guides/working-with-dictionaries#working-with-dictionaries-using-vcl-snippets).

!!! note
To make this example work, you must run [[= product_name =]] in version 3.3.16 or later, or 4.5.
Expand Down Expand Up @@ -478,4 +478,3 @@ fastly vcl snippet create --name="BasicAuth recv" --version=active --autoclone -
fastly vcl snippet create --name="BasicAuth error" --version=latest --priority 100 --type error --content=snippet_basic_auth_error.vcl
fastly service-version activate --version=latest
```

Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ For reverse proxies to work properly with your installation, you need to add the
- `snippet_re_enable_shielding.vcl` as snippet

The provided `.vcl` files work both with [Fastly Shielding](https://docs.fastly.com/en/guides/shielding) enabled and without it.
If you decide to use Fastly VCL, consider using [Fastly CLI](https://developer.fastly.com/learning/tools/cli/#installing) with it to manage VCL files from the command line.
If you decide to use Fastly VCL, consider using [Fastly CLI](https://www.fastly.com/documentation/reference/tools/cli/#installing) with it to manage VCL files from the command line.
To learn more, see [Prepare to use Fastly locally](fastly.md#prepare-for-using-fastly-locally) and [Introduction to Fastly CLI](fastly.md#quick-introduction-to-fastly-cli).

!!! tip "Support for Fastly Shielding was added in [[= product_name =]] v3.3.24 and v4.1.6"
Expand Down
Loading
Loading