From 51e8c451eda8c40234a95501663df16f42414b0a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Noco=C5=84?= Date: Fri, 29 Nov 2024 21:56:43 +0100 Subject: [PATCH 1/3] [CI] Added check for raw MkDocs variables in the generated HTML --- .github/workflows/build.yaml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 7bda6b4764..17e1acdf54 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -49,6 +49,15 @@ jobs: run: | mkdocs build --strict + - name: Verify that there are no variables in generated HTML + run: | + # Check for raw MkDocs variables in the generated HTML + if grep -Erl "\[\[=.*=\]\]" site > /dev/null; then + echo "Raw variables detected in the following files:" + grep -Erl "\[\[=.*=\]\]" site + exit 1 + fi + vale-check: runs-on: ubuntu-latest if: github.event_name == 'pull_request' From 1b9b643a6ac4041538990ef0a042eaf1cd774f7a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Noco=C5=84?= Date: Fri, 29 Nov 2024 20:00:52 +0100 Subject: [PATCH 2/3] Revert "variables fix (#2555)" This reverts commit 618066f1c7f6123a7dc1e5c2a291f5166c75e704. --- docs/getting_started/install_ibexa_dxp.md | 2 +- docs/ibexa_cloud/ddev_and_ibexa_cloud.md | 2 +- docs/ibexa_cloud/ibexa_cloud_guide.md | 2 +- docs/ibexa_cloud/install_on_ibexa_cloud.md | 2 +- docs/release_notes/ibexa_dxp_v3.2.md | 2 +- docs/release_notes/ibexa_dxp_v3.3.md | 2 +- docs/release_notes/ibexa_dxp_v4.0.md | 2 +- docs/release_notes/ibexa_dxp_v4.0_deprecations.md | 2 +- docs/release_notes/ibexa_dxp_v4.1.md | 2 +- docs/release_notes/ibexa_dxp_v4.2.md | 2 +- docs/release_notes/ibexa_dxp_v4.3.md | 2 +- docs/release_notes/ibexa_dxp_v4.4.md | 2 +- docs/release_notes/ibexa_dxp_v4.5.md | 2 +- docs/release_notes/ibexa_dxp_v4.6.md | 2 +- docs/resources/phpstorm_plugin.md | 2 +- docs/resources/release_process_and_roadmap.md | 2 +- 16 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/getting_started/install_ibexa_dxp.md b/docs/getting_started/install_ibexa_dxp.md index 4ef06022d3..4edf449bd2 100644 --- a/docs/getting_started/install_ibexa_dxp.md +++ b/docs/getting_started/install_ibexa_dxp.md @@ -2,7 +2,7 @@ description: Install Ibexa DXP on a Linux system and prepare your installation for production. --- -# Install Ibexa DXP +# Install [[= product_name =]] !!! note diff --git a/docs/ibexa_cloud/ddev_and_ibexa_cloud.md b/docs/ibexa_cloud/ddev_and_ibexa_cloud.md index 7656d508a2..c1fc1e1a3d 100644 --- a/docs/ibexa_cloud/ddev_and_ibexa_cloud.md +++ b/docs/ibexa_cloud/ddev_and_ibexa_cloud.md @@ -2,7 +2,7 @@ description: Use DDEV to run an Ibexa Cloud project locally. --- -# DDEV and Ibexa Cloud +# DDEV and [[= product_name_cloud =]] Two ways are available to run an [[= product_name_cloud =]] project locally with DDEV: diff --git a/docs/ibexa_cloud/ibexa_cloud_guide.md b/docs/ibexa_cloud/ibexa_cloud_guide.md index 7452ffb363..67876c3ced 100644 --- a/docs/ibexa_cloud/ibexa_cloud_guide.md +++ b/docs/ibexa_cloud/ibexa_cloud_guide.md @@ -4,7 +4,7 @@ title: Ibexa Cloud product guide month_change: false --- -# Ibexa Cloud product guide +# [[= product_name_cloud =]] product guide ## What is [[= product_name_cloud =]] diff --git a/docs/ibexa_cloud/install_on_ibexa_cloud.md b/docs/ibexa_cloud/install_on_ibexa_cloud.md index 8022cd2b1d..21fa0b9bfc 100644 --- a/docs/ibexa_cloud/install_on_ibexa_cloud.md +++ b/docs/ibexa_cloud/install_on_ibexa_cloud.md @@ -2,7 +2,7 @@ description: Install and configure Ibexa DXP to run in cloud using Ibexa Cloud. --- -# Install on Ibexa Cloud +# Install on [[= product_name_cloud =]] [[= product_name_cloud =]] enables you to host your application in the cloud by using the [Platform.sh](https://platform.sh/) service. diff --git a/docs/release_notes/ibexa_dxp_v3.2.md b/docs/release_notes/ibexa_dxp_v3.2.md index c6dfc50c21..abb4a1e775 100644 --- a/docs/release_notes/ibexa_dxp_v3.2.md +++ b/docs/release_notes/ibexa_dxp_v3.2.md @@ -1,6 +1,6 @@ -# Ibexa DXP v3.2 +# [[= product_name =]] v3.2 **Version number**: v3.2 diff --git a/docs/release_notes/ibexa_dxp_v3.3.md b/docs/release_notes/ibexa_dxp_v3.3.md index a4bdf90782..b18f723d5d 100644 --- a/docs/release_notes/ibexa_dxp_v3.3.md +++ b/docs/release_notes/ibexa_dxp_v3.3.md @@ -4,7 +4,7 @@ description: Ibexa DXP v3.3 is a Long Term Support release that offers a new Per -# Ibexa DXP v3.3 +# [[= product_name =]] v3.3 **Version number**: v3.3 diff --git a/docs/release_notes/ibexa_dxp_v4.0.md b/docs/release_notes/ibexa_dxp_v4.0.md index e6391cc517..a29dc6bcfa 100644 --- a/docs/release_notes/ibexa_dxp_v4.0.md +++ b/docs/release_notes/ibexa_dxp_v4.0.md @@ -1,6 +1,6 @@ -# Ibexa DXP v4.0 +# [[= product_name =]] 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 7a24755958..e62abdeddc 100644 --- a/docs/release_notes/ibexa_dxp_v4.0_deprecations.md +++ b/docs/release_notes/ibexa_dxp_v4.0_deprecations.md @@ -1,6 +1,6 @@ -# Ibexa DXP v4.0 deprecations and backwards compatibility breaks +# [[= product_name =]] v4.0 deprecations and backwards compatibility breaks [[= product_name =]] v4.0 introduces changes to significant parts of the code to align with the product name change from earlier eZ Platform. diff --git a/docs/release_notes/ibexa_dxp_v4.1.md b/docs/release_notes/ibexa_dxp_v4.1.md index 2ceede15e5..e807afe0bd 100644 --- a/docs/release_notes/ibexa_dxp_v4.1.md +++ b/docs/release_notes/ibexa_dxp_v4.1.md @@ -3,7 +3,7 @@ description: Ibexa DXP v4.1 enhances the PIM capabilities, adds a Measurement fi --- -# Ibexa DXP v4.1 +# [[= product_name =]] v4.1 **Version number**: v4.1 diff --git a/docs/release_notes/ibexa_dxp_v4.2.md b/docs/release_notes/ibexa_dxp_v4.2.md index 5690421e25..caf94b9968 100644 --- a/docs/release_notes/ibexa_dxp_v4.2.md +++ b/docs/release_notes/ibexa_dxp_v4.2.md @@ -4,7 +4,7 @@ description: Ibexa DXP v4.2 adds the Customer Portal and user management capabil -# Ibexa DXP v4.2 +# [[= product_name =]] v4.2 **Version number**: v4.2 diff --git a/docs/release_notes/ibexa_dxp_v4.3.md b/docs/release_notes/ibexa_dxp_v4.3.md index 5c56547022..122023c7aa 100644 --- a/docs/release_notes/ibexa_dxp_v4.3.md +++ b/docs/release_notes/ibexa_dxp_v4.3.md @@ -3,7 +3,7 @@ description: Ibexa DXP v4.3 adds the improvements to the Customer Portal, PIM an --- -# Ibexa DXP v4.3 +# [[= product_name =]] v4.3 **Version number**: v4.3 diff --git a/docs/release_notes/ibexa_dxp_v4.4.md b/docs/release_notes/ibexa_dxp_v4.4.md index 380d469872..89c80bb015 100644 --- a/docs/release_notes/ibexa_dxp_v4.4.md +++ b/docs/release_notes/ibexa_dxp_v4.4.md @@ -3,7 +3,7 @@ description: Ibexa DXP v4.4 adds the improvements to the Welcome Page, All-new I --- -# Ibexa DXP v4.4 +# [[= product_name =]] v4.4 **Version number**: v4.4 diff --git a/docs/release_notes/ibexa_dxp_v4.5.md b/docs/release_notes/ibexa_dxp_v4.5.md index dbef59b14e..55240fe4bf 100644 --- a/docs/release_notes/ibexa_dxp_v4.5.md +++ b/docs/release_notes/ibexa_dxp_v4.5.md @@ -4,7 +4,7 @@ description: Ibexa DXP v4.5 adds new features to Ibexa Commerce, translation com -# Ibexa DXP v4.5 +# [[= product_name =]] v4.5 **Version number**: v4.5 diff --git a/docs/release_notes/ibexa_dxp_v4.6.md b/docs/release_notes/ibexa_dxp_v4.6.md index 73ba83693c..335f1e7af7 100644 --- a/docs/release_notes/ibexa_dxp_v4.6.md +++ b/docs/release_notes/ibexa_dxp_v4.6.md @@ -4,7 +4,7 @@ description: Ibexa DXP v4.6 brings improvements to Commerce, PIM and Personaliza -# Ibexa DXP v4.6 +# [[= product_name =]] v4.6 **Version number**: v4.6 diff --git a/docs/resources/phpstorm_plugin.md b/docs/resources/phpstorm_plugin.md index eab598809b..820971cdbe 100644 --- a/docs/resources/phpstorm_plugin.md +++ b/docs/resources/phpstorm_plugin.md @@ -2,7 +2,7 @@ description: The Ibexa DXP PHPStorm plugin helps you speed up your development by providing file templates, autocompletion, a quick installation wizard, and more. --- -# Ibexa DXP plugin for PhpStorm +# [[= product_name =]] plugin for PhpStorm [[= product_name =]] plugin for PhpStorm helps you to work with [[= product_name =]] by speeding up installation and providing file templates, intentions, autocompletion, and other features. diff --git a/docs/resources/release_process_and_roadmap.md b/docs/resources/release_process_and_roadmap.md index 6fcda0bb80..ebe1d5fabd 100644 --- a/docs/resources/release_process_and_roadmap.md +++ b/docs/resources/release_process_and_roadmap.md @@ -2,7 +2,7 @@ description: "Ibexa DXP releases new versions periodically in different flavors: Ibexa Headless, Ibexa Experience and Ibexa Commerce, plus open-source Ibexa OSS." --- -# Ibexa DXP release process and roadmap +# [[= product_name =]] release process and roadmap ## Release process From 7c19c944077f7c9808f8c88ed21aa9cde24b7c1f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Noco=C5=84?= Date: Fri, 29 Nov 2024 20:04:09 +0100 Subject: [PATCH 3/3] Revert "Revert "variables fix (#2555)"" This reverts commit 1b9b643a6ac4041538990ef0a042eaf1cd774f7a. --- docs/getting_started/install_ibexa_dxp.md | 2 +- docs/ibexa_cloud/ddev_and_ibexa_cloud.md | 2 +- docs/ibexa_cloud/ibexa_cloud_guide.md | 2 +- docs/ibexa_cloud/install_on_ibexa_cloud.md | 2 +- docs/release_notes/ibexa_dxp_v3.2.md | 2 +- docs/release_notes/ibexa_dxp_v3.3.md | 2 +- docs/release_notes/ibexa_dxp_v4.0.md | 2 +- docs/release_notes/ibexa_dxp_v4.0_deprecations.md | 2 +- docs/release_notes/ibexa_dxp_v4.1.md | 2 +- docs/release_notes/ibexa_dxp_v4.2.md | 2 +- docs/release_notes/ibexa_dxp_v4.3.md | 2 +- docs/release_notes/ibexa_dxp_v4.4.md | 2 +- docs/release_notes/ibexa_dxp_v4.5.md | 2 +- docs/release_notes/ibexa_dxp_v4.6.md | 2 +- docs/resources/phpstorm_plugin.md | 2 +- docs/resources/release_process_and_roadmap.md | 2 +- 16 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/getting_started/install_ibexa_dxp.md b/docs/getting_started/install_ibexa_dxp.md index 4edf449bd2..4ef06022d3 100644 --- a/docs/getting_started/install_ibexa_dxp.md +++ b/docs/getting_started/install_ibexa_dxp.md @@ -2,7 +2,7 @@ description: Install Ibexa DXP on a Linux system and prepare your installation for production. --- -# Install [[= product_name =]] +# Install Ibexa DXP !!! note diff --git a/docs/ibexa_cloud/ddev_and_ibexa_cloud.md b/docs/ibexa_cloud/ddev_and_ibexa_cloud.md index c1fc1e1a3d..7656d508a2 100644 --- a/docs/ibexa_cloud/ddev_and_ibexa_cloud.md +++ b/docs/ibexa_cloud/ddev_and_ibexa_cloud.md @@ -2,7 +2,7 @@ description: Use DDEV to run an Ibexa Cloud project locally. --- -# DDEV and [[= product_name_cloud =]] +# DDEV and Ibexa Cloud Two ways are available to run an [[= product_name_cloud =]] project locally with DDEV: diff --git a/docs/ibexa_cloud/ibexa_cloud_guide.md b/docs/ibexa_cloud/ibexa_cloud_guide.md index 67876c3ced..7452ffb363 100644 --- a/docs/ibexa_cloud/ibexa_cloud_guide.md +++ b/docs/ibexa_cloud/ibexa_cloud_guide.md @@ -4,7 +4,7 @@ title: Ibexa Cloud product guide month_change: false --- -# [[= product_name_cloud =]] product guide +# Ibexa Cloud product guide ## What is [[= product_name_cloud =]] diff --git a/docs/ibexa_cloud/install_on_ibexa_cloud.md b/docs/ibexa_cloud/install_on_ibexa_cloud.md index 21fa0b9bfc..8022cd2b1d 100644 --- a/docs/ibexa_cloud/install_on_ibexa_cloud.md +++ b/docs/ibexa_cloud/install_on_ibexa_cloud.md @@ -2,7 +2,7 @@ description: Install and configure Ibexa DXP to run in cloud using Ibexa Cloud. --- -# Install on [[= product_name_cloud =]] +# Install on Ibexa Cloud [[= product_name_cloud =]] enables you to host your application in the cloud by using the [Platform.sh](https://platform.sh/) service. diff --git a/docs/release_notes/ibexa_dxp_v3.2.md b/docs/release_notes/ibexa_dxp_v3.2.md index abb4a1e775..c6dfc50c21 100644 --- a/docs/release_notes/ibexa_dxp_v3.2.md +++ b/docs/release_notes/ibexa_dxp_v3.2.md @@ -1,6 +1,6 @@ -# [[= product_name =]] v3.2 +# Ibexa DXP v3.2 **Version number**: v3.2 diff --git a/docs/release_notes/ibexa_dxp_v3.3.md b/docs/release_notes/ibexa_dxp_v3.3.md index b18f723d5d..a4bdf90782 100644 --- a/docs/release_notes/ibexa_dxp_v3.3.md +++ b/docs/release_notes/ibexa_dxp_v3.3.md @@ -4,7 +4,7 @@ description: Ibexa DXP v3.3 is a Long Term Support release that offers a new Per -# [[= product_name =]] v3.3 +# Ibexa DXP v3.3 **Version number**: v3.3 diff --git a/docs/release_notes/ibexa_dxp_v4.0.md b/docs/release_notes/ibexa_dxp_v4.0.md index a29dc6bcfa..e6391cc517 100644 --- a/docs/release_notes/ibexa_dxp_v4.0.md +++ b/docs/release_notes/ibexa_dxp_v4.0.md @@ -1,6 +1,6 @@ -# [[= product_name =]] v4.0 +# 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 e62abdeddc..7a24755958 100644 --- a/docs/release_notes/ibexa_dxp_v4.0_deprecations.md +++ b/docs/release_notes/ibexa_dxp_v4.0_deprecations.md @@ -1,6 +1,6 @@ -# [[= product_name =]] v4.0 deprecations and backwards compatibility breaks +# Ibexa DXP v4.0 deprecations and backwards compatibility breaks [[= product_name =]] v4.0 introduces changes to significant parts of the code to align with the product name change from earlier eZ Platform. diff --git a/docs/release_notes/ibexa_dxp_v4.1.md b/docs/release_notes/ibexa_dxp_v4.1.md index e807afe0bd..2ceede15e5 100644 --- a/docs/release_notes/ibexa_dxp_v4.1.md +++ b/docs/release_notes/ibexa_dxp_v4.1.md @@ -3,7 +3,7 @@ description: Ibexa DXP v4.1 enhances the PIM capabilities, adds a Measurement fi --- -# [[= product_name =]] v4.1 +# Ibexa DXP v4.1 **Version number**: v4.1 diff --git a/docs/release_notes/ibexa_dxp_v4.2.md b/docs/release_notes/ibexa_dxp_v4.2.md index caf94b9968..5690421e25 100644 --- a/docs/release_notes/ibexa_dxp_v4.2.md +++ b/docs/release_notes/ibexa_dxp_v4.2.md @@ -4,7 +4,7 @@ description: Ibexa DXP v4.2 adds the Customer Portal and user management capabil -# [[= product_name =]] v4.2 +# Ibexa DXP v4.2 **Version number**: v4.2 diff --git a/docs/release_notes/ibexa_dxp_v4.3.md b/docs/release_notes/ibexa_dxp_v4.3.md index 122023c7aa..5c56547022 100644 --- a/docs/release_notes/ibexa_dxp_v4.3.md +++ b/docs/release_notes/ibexa_dxp_v4.3.md @@ -3,7 +3,7 @@ description: Ibexa DXP v4.3 adds the improvements to the Customer Portal, PIM an --- -# [[= product_name =]] v4.3 +# Ibexa DXP v4.3 **Version number**: v4.3 diff --git a/docs/release_notes/ibexa_dxp_v4.4.md b/docs/release_notes/ibexa_dxp_v4.4.md index 89c80bb015..380d469872 100644 --- a/docs/release_notes/ibexa_dxp_v4.4.md +++ b/docs/release_notes/ibexa_dxp_v4.4.md @@ -3,7 +3,7 @@ description: Ibexa DXP v4.4 adds the improvements to the Welcome Page, All-new I --- -# [[= product_name =]] v4.4 +# Ibexa DXP v4.4 **Version number**: v4.4 diff --git a/docs/release_notes/ibexa_dxp_v4.5.md b/docs/release_notes/ibexa_dxp_v4.5.md index 55240fe4bf..dbef59b14e 100644 --- a/docs/release_notes/ibexa_dxp_v4.5.md +++ b/docs/release_notes/ibexa_dxp_v4.5.md @@ -4,7 +4,7 @@ description: Ibexa DXP v4.5 adds new features to Ibexa Commerce, translation com -# [[= product_name =]] v4.5 +# Ibexa DXP v4.5 **Version number**: v4.5 diff --git a/docs/release_notes/ibexa_dxp_v4.6.md b/docs/release_notes/ibexa_dxp_v4.6.md index 335f1e7af7..73ba83693c 100644 --- a/docs/release_notes/ibexa_dxp_v4.6.md +++ b/docs/release_notes/ibexa_dxp_v4.6.md @@ -4,7 +4,7 @@ description: Ibexa DXP v4.6 brings improvements to Commerce, PIM and Personaliza -# [[= product_name =]] v4.6 +# Ibexa DXP v4.6 **Version number**: v4.6 diff --git a/docs/resources/phpstorm_plugin.md b/docs/resources/phpstorm_plugin.md index 820971cdbe..eab598809b 100644 --- a/docs/resources/phpstorm_plugin.md +++ b/docs/resources/phpstorm_plugin.md @@ -2,7 +2,7 @@ description: The Ibexa DXP PHPStorm plugin helps you speed up your development by providing file templates, autocompletion, a quick installation wizard, and more. --- -# [[= product_name =]] plugin for PhpStorm +# Ibexa DXP plugin for PhpStorm [[= product_name =]] plugin for PhpStorm helps you to work with [[= product_name =]] by speeding up installation and providing file templates, intentions, autocompletion, and other features. diff --git a/docs/resources/release_process_and_roadmap.md b/docs/resources/release_process_and_roadmap.md index ebe1d5fabd..6fcda0bb80 100644 --- a/docs/resources/release_process_and_roadmap.md +++ b/docs/resources/release_process_and_roadmap.md @@ -2,7 +2,7 @@ description: "Ibexa DXP releases new versions periodically in different flavors: Ibexa Headless, Ibexa Experience and Ibexa Commerce, plus open-source Ibexa OSS." --- -# [[= product_name =]] release process and roadmap +# Ibexa DXP release process and roadmap ## Release process