Skip to content

Commit 6555a38

Browse files
committed
Merge remote-tracking branch 'origin/4.6' into tmp-enh-phpdoc
# Conflicts: # docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-Location.html # docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-ValueObject.html
2 parents 87ab607 + 939f883 commit 6555a38

File tree

11 files changed

+120
-182
lines changed

11 files changed

+120
-182
lines changed

.github/workflows/build.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,15 @@ jobs:
4949
run: |
5050
mkdocs build --strict
5151
52+
- name: Verify that there are no variables in generated HTML
53+
run: |
54+
# Check for raw MkDocs variables in the generated HTML
55+
if grep -Erl "\[\[=.*=\]\]" site > /dev/null; then
56+
echo "Raw variables detected in the following files:"
57+
grep -Erl "\[\[=.*=\]\]" site
58+
exit 1
59+
fi
60+
5261
vale-check:
5362
runs-on: ubuntu-latest
5463
if: github.event_name == 'pull_request'

docs/api/graphql/graphql_queries.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ To get a specific content item by its content ID, location ID, or URL alias, use
1515
```
1616
{
1717
content {
18-
article (contentId: 62) {
18+
article(contentId: 62) {
1919
title
2020
author {
2121
name
@@ -52,8 +52,17 @@ The query accepts `locationId`, `remoteId`, and `urlAlias` as arguments.
5252

5353
```
5454
{
55-
item (locationId: 2) {
55+
item(locationId: 2) {
5656
_name
57+
... on FolderItem {
58+
name
59+
}
60+
... on LandingPageItem {
61+
name
62+
}
63+
... on ArticleItem {
64+
title
65+
}
5766
}
5867
}
5968
```
@@ -181,9 +190,9 @@ To get the IDs and names of all Fields in the `article` content type:
181190
{
182191
content {
183192
_types {
184-
article{
193+
article {
185194
_info {
186-
fieldDefinitions{
195+
fieldDefinitions {
187196
id
188197
name
189198
}
@@ -318,8 +327,8 @@ Alternatively, you can query the `children` property of an `item` or `content` o
318327

319328
```
320329
{
321-
item (locationId: 2) {
322-
_location{
330+
item(locationId: 2) {
331+
_location {
323332
children {
324333
edges {
325334
node {

docs/css/custom.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -379,6 +379,10 @@ ul li li li {
379379
background-color: var(--table-header);
380380
}
381381

382+
.md-typeset table td.compare {
383+
border: 0.05rem solid var(--md-typeset-table-color)
384+
}
385+
382386
.md-nav__link[data-md-state=blur] {
383387
color: rgb(19, 28, 38);
384388
}

docs/getting_started/requirements.md

Lines changed: 1 addition & 163 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
3737
|Debian 11 "Bullseye"|11.0-11.7+|
3838
|Ubuntu "Focal Fossa" | 20.04 |
3939
|Ubuntu "Jammy Jellyfish"| 22.04 |
40+
|Ubuntu "Noble Numbat"| 24.04 |
4041
|RHEL / CentOS | 8.1-8.5+ |
4142

4243
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
@@ -55,17 +56,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
5556
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
5657
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
5758

58-
=== "eZ Platform v2.5"
59-
60-
|Name|Version|
61-
|---|---|
62-
|Debian 10 "Buster" |10.0-10.13+|
63-
|Ubuntu "Bionic" | 18.04 LTS |
64-
|RHEL / CentOS | 8.0-8.5+ |
65-
66-
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
67-
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
68-
6959
## Web server
7060

7161
=== "[[= product_name =]] v4.6"
@@ -83,12 +73,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
8373
- Apache 2.4 (with required modules `mod_rewrite`, `mod_env` and recommended: `mod_setenvif`, `mod_expires`;
8474
event MPM is recommended, if you need to use prefork you also need the `mod_php` module)
8575

86-
=== "eZ Platform v2.5"
87-
88-
- Nginx 1.12, 1.14, 1.16
89-
- Apache 2.4 (with required modules `mod_rewrite`, `mod_env` and recommended: `mod_setenvif`, `mod_expires`;
90-
event MPM is recommended, if you need to use prefork you also need the `mod_php` module)
91-
9276
## DBMS
9377

9478
=== "[[= product_name =]] v4.6"
@@ -109,16 +93,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
10993
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
11094
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
11195

112-
=== "eZ Platform v2.5"
113-
114-
- MariaDB 10.3, 10.4 (optionally 10.2 - deprecated)
115-
- MySQL 8.0 (optionally 5.7 - deprecated)
116-
- PostgreSQL 10+ (PostgreSQL 10 has reached its End of Life.
117-
We highly recommend using PostgreSQL 14 for optimal performance and security)
118-
119-
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
120-
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
121-
12296
## PHP
12397

12498
=== "[[= product_name =]] v4.6"
@@ -138,16 +112,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
138112
- 7.4 (PHP 7.4 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should use PHP 8.1)
139113
- 7.3 (PHP 7.3 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should use PHP 8.1)
140114

141-
=== "eZ Platform v2.5"
142-
143-
- 7.1 (PHP 7.1 has reached its End of Life.
144-
Unless you have extended support from vendors like Debian or Zend, you should upgrade to [[= product_name =]] v3.3 or v4.x)
145-
- 7.2 (PHP 7.2 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should upgrade to [[= product_name =]]P v3.3 or v4.x)
146-
- 7.3 (PHP 7.3 has reached its End of Life.
147-
Unless you have extended support from vendors like Debian or Zend, you should upgrade to [[= product_name =]] v3.3 or v4.x)
148-
- 7.4 (PHP 7.4 has reached its End of Life.
149-
Unless you have extended support from vendors like Debian or Zend, you should upgrade to [[= product_name =]] v3.3 or v4.x)
150-
151115
### PHP extensions
152116

153117
=== "[[= product_name =]] v4.6"
@@ -181,20 +145,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
181145
- `php-gd` or `php-imagick` (via pecl on RHEL/CentOS)
182146
- `php-sodium`
183147

184-
=== "eZ Platform v2.5"
185-
186-
- `php-cli`
187-
- `php-fpm`
188-
- `php-mysql` (`php-mysqlnd`) or `php-pgsql`
189-
- `php-xml`
190-
- `php-mbstring`
191-
- `php-json`
192-
- `php-process` (on RHEL/CentOS)
193-
- `php-intl`
194-
- `php-curl`
195-
- `php-pear` (optional, provides pecl)
196-
- `php-gd` or `php-imagick` (via pecl on RHEL/CentOS)
197-
198148
### Cluster PHP extensions
199149

200150
=== "[[= product_name =]] v4.6"
@@ -205,13 +155,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
205155

206156
- `php-redis` or `php-memcached`
207157

208-
=== "eZ Platform v2.5"
209-
210-
- `php-redis` 3.1.3+ or `php-memcached` 3.x+*
211-
212-
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
213-
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
214-
215158
## Search
216159

217160
=== "[[= product_name =]] v4.6"
@@ -228,14 +171,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
228171
- For BinaryFile field indexing, Apache Tika 1.20 or higher 1.x version, recommended 1.28.1 or higher.
229172
- The above solutions require Oracle Java/Open JDK. The minimum requirement is 8 LTS, recommended 11 LTS. Newer versions aren't supported.
230173

231-
=== "eZ Platform v2.5"
232-
233-
- For content search, Solr 7.7 LTS or Solr 8, recommended 8.11.1 or higher.
234-
Alternatively, Elasticsearch 7.16.2 or higher 7.x version.
235-
- For BinaryFile field indexing, Apache Tika 1.20 or higher 1.x version, recommended 1.28.1 or higher.
236-
- The above solutions require Oracle Java/Open JDK.
237-
The minimum requirement is 8 LTS, recommended 11 LTS. Newer versions aren't supported.
238-
239174
## Graphic Handler
240175

241176
=== "[[= product_name =]] v4.6"
@@ -268,12 +203,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
268203
- Gifsicle
269204
- cwebp
270205

271-
=== "eZ Platform v2.5"
272-
273-
- GraphicsMagick
274-
- ImageMagick
275-
- GD
276-
277206
## [Clustering](clustering.md)
278207

279208
=== "[[= product_name =]] v4.6"
@@ -294,15 +223,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
294223
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
295224
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
296225

297-
=== "eZ Platform v2.5"
298-
299-
- Linux NFS or S3/EFS (for IO, aka binary files stored in content repository, not supported with legacy)
300-
- Redis 3.2+ (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
301-
- [Varnish](http://varnish-cache.org/) 5.1 or 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/2.5/guide/cache/http_cache/#serving-varnish-through-fastly) (for HTTP Cache)
302-
303-
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
304-
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
305-
306226
## Filesystem
307227

308228
=== "[[= product_name =]] v4.6"
@@ -313,10 +233,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
313233

314234
- Linux ext4 / XFS
315235

316-
=== "eZ Platform v2.5"
317-
318-
- Linux ext4 / XFS
319-
320236
## Package manager
321237

322238
=== "[[= product_name =]] v4.6"
@@ -327,10 +243,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
327243

328244
- Composer: recent 2.1 version
329245

330-
=== "eZ Platform v2.5"
331-
332-
- Composer: recent 2.1 version
333-
334246
## Asset manager
335247

336248
=== "[[= product_name =]] v4.6"
@@ -350,14 +262,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
350262
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
351263
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
352264

353-
=== "eZ Platform v2.5"
354-
355-
- `Node.js` 10, 12 or 14
356-
- `yarn` 1.15.2+
357-
358-
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
359-
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
360-
361265
## Browser
362266

363267
=== "[[= product_name =]] v4.6"
@@ -380,16 +284,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
380284
- Chromium™ based browsers such as Microsoft® Edge® and Opera®, most recent stable version, desktop *and* tablet
381285
- Apple® Safari® most recent stable version, desktop *and* tablet
382286

383-
=== "eZ Platform v2.5"
384-
385-
eZ Platform is developed to work with *any* web browser that supports modern standards, on *any* screen resolution suitable for web, running on *any* device.
386-
However for the Editorial and Administration User Interfaces you need: a minimum of 1366-by-768 screen resolution, a desktop or tablet device, and a recommended/supported browser among the ones found below.
387-
388-
- Mozilla® Firefox® most recent stable version (recommended)
389-
- Google Chrome™ most recent stable version (recommended)
390-
- Chromium™ based browsers such as Microsoft® Edge® and Opera®, most recent stable version, desktop *and* tablet
391-
- Apple® Safari® most recent stable version, desktop *and* tablet
392-
393287
## [[= product_name_cloud =]] requirements and setup
394288

395289
=== "[[= product_name_cloud =]] v4.6"
@@ -485,59 +379,3 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
485379

486380
For example, you can create an integration with S3 by means of setting up your own S3 bucket and configuring the relevant parts of [[= product_name =]].
487381
We recommend giving the development team working on the project access to the bucket to ensure work is done in a DevOps way without depending on external teams when changes are needed.
488-
489-
=== "eZ Platform Cloud v2.5"
490-
491-
### Cloud hosting with eZ Platform Cloud and Platform.sh
492-
493-
In general, eZ Platform Cloud supports all features and services of [Platform.sh](https://platform.sh/marketplace/ibexa/) that are compatible and supported by the eZ Platform version you use.
494-
495-
For example:
496-
497-
- Platform.sh provides Redis support for versions 2.8, 3.0 and 3.2. eZ Platform supports Redis version 3.2 or higher.
498-
As a result, Redis is supported by eZ Platform Cloud versions 3.2.
499-
- Platform.sh provides Elasticsearch service (different versions supported).
500-
Elasticsearch isn't supported for use as search engine for eZ Platform.
501-
502-
Features or services supported by eZ Platform but not covered by Platform.sh may be possible by means of a [custom integration](#custom-integrations).
503-
504-
### Recommended eZ Platform Cloud setup
505-
506-
For more details on recommended setup configuration see bundled `.platform.app.yaml` and `.platform/` configuration files.
507-
508-
These files are kept up-to-date with latest recommendations and can be improved through contributions.
509-
510-
### Supported eZ Platform Cloud setup
511-
512-
Because of the large range of possible configurations of eZ Publish legacy, there is no ready-made recommended setup.
513-
Make sure to set aside time and budget for:
514-
515-
- Verifying your legacy configuration and ensuring it's supported by Platform.sh
516-
- Additional time for adaptation and configuration work, and testing by your own team
517-
- Additional consulting/onboarding time with Platform.sh, Ibexa technical services, and/or one of the many partners with prior experience in using Platform.sh with eZ Publish legacy
518-
519-
The cost and effort of this isn't included in eZ Platform Cloud subscription and is vary depending on the project.
520-
521-
### Experimental/custom Platform.sh setups
522-
523-
Any use of experimental versions or setups isn't eligible for use with eZ Platform Cloud.
524-
However, it's possible to use an eZ Enterprise subscription in combination with a Platform.sh contract, where you or a partner take ownership of the configuration to set up the project.
525-
526-
Such projects are possible by means of custom integrations/configuration, but they may generate issues that aren't covered by eZ Enterprise subscription bug fix guarantee.
527-
528-
!!! tip "Use a partner with prior experience on legacy and Platform.sh"
529-
530-
If you're in need of setting up your legacy project on Platform.sh for a transitional period, eZ can put you in contact with a partner experienced in setting up older projects on Platform.sh.
531-
This saves you a lot of time and effort.
532-
533-
!!! note
534-
535-
As Platform.sh doesn't support a configuration with multiple PostgreSQL databases, for eZ Platform Cloud / Platform.sh it's impossible to have a DFS table in a separate database.
536-
537-
### Custom integrations
538-
539-
Features supported by eZ Platform, but not natively by Platform.sh, can in many cases be used by means of custom integrations with external services.
540-
541-
For example, you can create an integration with S3 by means of setting up your own S3 bucket and configuring the relevant parts of eZ Platform.
542-
We recommend giving the development team working on the project access to the bucket
543-
to ensure work is done in a DevOps way without depending on external teams when changes are needed.

docs/js/custom.js

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,20 @@ $(document).ready(function() {
1818
warningBox.hidden = false;
1919
}
2020

21-
$('.md-content a.md-icon').each(function() {
21+
if (!/^\d+\.\d+$/.test(branchName) && branchName !== 'latest') {
22+
branchName = 'master';
23+
}
24+
25+
// Insert version into header links
26+
$('.md-header a.md-logo, #site-name > a').each(function() {
2227
$(this).attr(
2328
'href',
2429
$(this)
2530
.attr('href')
26-
.replace('master/docs/', branchName + '/docs/'),
31+
.replace(/\/en\/[^\/]+\//, '/en/' + branchName + '/'),
2732
);
2833
});
2934

30-
if (!/^\d+\.\d+$/.test(branchName) && branchName !== 'latest') {
31-
branchName = 'master';
32-
}
33-
3435
// Add version pill to top of navigation
3536
$('#site-name').append('<span class="pill">' + branchName + '</span>');
3637

docs/release_notes/release_notes.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,5 @@ The latest stable and LTS (Long Term Support) version of [[= product_name =]] is
1010

1111
[[= cards([
1212
"release_notes/ibexa_dxp_v4.6",
13-
"release_notes/ibexa_dxp_v4.5",
1413
"release_notes/ibexa_dxp_v3.3",
15-
"release_notes/ez_platform_v2.5",
16-
], columns=4) =]]
14+
], columns=2) =]]

0 commit comments

Comments
 (0)