From 3f572d5151cd2376910a5eff92b87a83cdb4624f Mon Sep 17 00:00:00 2001 From: Yanick Witschi Date: Mon, 29 Sep 2025 11:47:45 +0200 Subject: [PATCH 1/2] Make LTS version a site parameter --- docs/dev/getting-started/initial-setup/_index.md | 4 ++-- docs/dev/getting-started/initial-setup/managed-edition.md | 4 ++-- page/config/_default/params.yml | 5 +++-- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/dev/getting-started/initial-setup/_index.md b/docs/dev/getting-started/initial-setup/_index.md index 99310d1ca..d2882e44c 100644 --- a/docs/dev/getting-started/initial-setup/_index.md +++ b/docs/dev/getting-started/initial-setup/_index.md @@ -23,11 +23,11 @@ bundles for example (e.g. for Contao Extensions). Head over to the linked articl to learn more about the Managed Edition. To install a specific version of the Contao Managed Edition in the current directory (`.`), run the -command as follows (e.g. for `4.9`): +command as follows (e.g. for `{{% siteparam "currentContaoLtsVersion" %}}`): ```bash -composer create-project contao/managed-edition . 4.9 +composer create-project contao/managed-edition . {{% siteparam "currentContaoLtsVersion" %}} ``` [1]: symfony-application diff --git a/docs/dev/getting-started/initial-setup/managed-edition.md b/docs/dev/getting-started/initial-setup/managed-edition.md index 1b080afbf..0320966a6 100644 --- a/docs/dev/getting-started/initial-setup/managed-edition.md +++ b/docs/dev/getting-started/initial-setup/managed-edition.md @@ -20,8 +20,8 @@ The heart of the `Managed Edition` consists of two main components: * [The Manager Plugin (contao/manager-plugin)](https://github.com/contao/manager-plugin) The `Manager Bundle` contains the full application skeleton such as entry points, config files etc. thus giving us full -control on how the application is built during an update. Hence, if you want to install e.g. Contao 4.7, you would require -`contao/manager-bundle` in `4.7.*`. +control on how the application is built during an update. Hence, if you want to install e.g. Contao {{% siteparam "currentContaoLtsVersion" %}}, you would require +`contao/manager-bundle` in `{{% siteparam "currentContaoLtsVersion" %}}.*`. {{% notice note %}} To start a new project, don't just require the `contao/manager-bundle` because you'll also need the `post-install` and diff --git a/page/config/_default/params.yml b/page/config/_default/params.yml index 96ed396fb..8e69186c5 100644 --- a/page/config/_default/params.yml +++ b/page/config/_default/params.yml @@ -13,8 +13,9 @@ search: disableLanguageSwitch: true documentation_label: Documentation disableInlineCopyToClipBoard: true -currentContaoVersion: '5.5' -currentReleaseCandidate: '5.6' +currentContaoLtsVersion: '5.3' +currentContaoVersion: '5.6' +currentReleaseCandidate: '5.7' disableLandingPageButton: true banner: show: false From d6020c799413356af12af95d44346957d2a1bd3f Mon Sep 17 00:00:00 2001 From: fritzmg Date: Mon, 29 Sep 2025 15:38:23 +0100 Subject: [PATCH 2/2] Use currentContaoVersion everywhere, remove old shortcode --- docs/dev/framework/security/_index.md | 2 +- docs/dev/getting-started/initial-setup/_index.md | 4 ++-- docs/dev/getting-started/initial-setup/managed-edition.md | 4 ++-- docs/manual/guides/local-installation/ddev.de.md | 4 ++-- docs/manual/guides/local-installation/ddev.en.md | 4 ++-- docs/manual/guides/local-installation/devilbox.de.md | 6 +++--- docs/manual/guides/local-installation/devilbox.en.md | 6 +++--- docs/manual/guides/local-installation/laragon.de.md | 2 +- docs/manual/guides/local-installation/laragon.en.md | 2 +- docs/manual/installation/install-contao.de.md | 4 ++-- docs/manual/installation/install-contao.en.md | 4 ++-- page/config/_default/params.yml | 3 +-- page/layouts/shortcodes/current-version.html | 1 - 13 files changed, 22 insertions(+), 24 deletions(-) delete mode 100644 page/layouts/shortcodes/current-version.html diff --git a/docs/dev/framework/security/_index.md b/docs/dev/framework/security/_index.md index 31922618e..696d02e6f 100644 --- a/docs/dev/framework/security/_index.md +++ b/docs/dev/framework/security/_index.md @@ -10,7 +10,7 @@ authentication and authorization. The Contao Managed Edition provides its own [f [user providers][SymfonyUserProvider] and [access control][SymfonyAccessControl] via the `contao/manager-bundle`. If you do not use the Managed Edition and added Contao to your custom Symfony application, you will have to register Contao's security settings yourself, as mentioned in the [Getting Started article][ContaoConfiguration]. Contao's Symfony -Security configuration in Contao **{{< current-version >}}** [looks like this][ContaoSecurityYaml] for example. +Security configuration in Contao **{{% siteparam "currentContaoVersion" %}}** [looks like this][ContaoSecurityYaml] for example. If you want to learn more about Symfony's Security Component use the provided links to read up on. This documentation will only cover implementation details that are unique to Contao. diff --git a/docs/dev/getting-started/initial-setup/_index.md b/docs/dev/getting-started/initial-setup/_index.md index d2882e44c..da34fc3ca 100644 --- a/docs/dev/getting-started/initial-setup/_index.md +++ b/docs/dev/getting-started/initial-setup/_index.md @@ -23,11 +23,11 @@ bundles for example (e.g. for Contao Extensions). Head over to the linked articl to learn more about the Managed Edition. To install a specific version of the Contao Managed Edition in the current directory (`.`), run the -command as follows (e.g. for `{{% siteparam "currentContaoLtsVersion" %}}`): +command as follows (e.g. for `{{% siteparam "currentContaoVersion" %}}`): ```bash -composer create-project contao/managed-edition . {{% siteparam "currentContaoLtsVersion" %}} +composer create-project contao/managed-edition . {{% siteparam "currentContaoVersion" %}} ``` [1]: symfony-application diff --git a/docs/dev/getting-started/initial-setup/managed-edition.md b/docs/dev/getting-started/initial-setup/managed-edition.md index 0320966a6..84da4d232 100644 --- a/docs/dev/getting-started/initial-setup/managed-edition.md +++ b/docs/dev/getting-started/initial-setup/managed-edition.md @@ -20,8 +20,8 @@ The heart of the `Managed Edition` consists of two main components: * [The Manager Plugin (contao/manager-plugin)](https://github.com/contao/manager-plugin) The `Manager Bundle` contains the full application skeleton such as entry points, config files etc. thus giving us full -control on how the application is built during an update. Hence, if you want to install e.g. Contao {{% siteparam "currentContaoLtsVersion" %}}, you would require -`contao/manager-bundle` in `{{% siteparam "currentContaoLtsVersion" %}}.*`. +control on how the application is built during an update. Hence, if you want to install e.g. Contao {{% siteparam "currentContaoVersion" %}}, you would require +`contao/manager-bundle` in `{{% siteparam "currentContaoVersion" %}}.*`. {{% notice note %}} To start a new project, don't just require the `contao/manager-bundle` because you'll also need the `post-install` and diff --git a/docs/manual/guides/local-installation/ddev.de.md b/docs/manual/guides/local-installation/ddev.de.md index 36cd16a37..76556b1d2 100644 --- a/docs/manual/guides/local-installation/ddev.de.md +++ b/docs/manual/guides/local-installation/ddev.de.md @@ -50,10 +50,10 @@ DDEV-Konfiguration anlegen mit: ddev config --project-type=php --docroot=public --webserver-type=apache-fpm --php-version=8.2 ``` -Contao 5.3 installieren: +Contao {{% siteparam "currentContaoVersion" %}} installieren: ```shell -ddev composer create-project contao/managed-edition:5.3 +ddev composer create-project contao/managed-edition:{{% siteparam "currentContaoVersion" %}} ``` Nach der Installation müssen die Datenbankzugangsdaten in die `.env.local` eingetragen werden. In diesem Zug richten wir auch direkt diff --git a/docs/manual/guides/local-installation/ddev.en.md b/docs/manual/guides/local-installation/ddev.en.md index 1336bd8b1..0e3d53dc5 100644 --- a/docs/manual/guides/local-installation/ddev.en.md +++ b/docs/manual/guides/local-installation/ddev.en.md @@ -48,10 +48,10 @@ Create the DDEV configuration with: ddev config --project-type=php --docroot=public --webserver-type=apache-fpm --php-version=8.2 ``` -Install Contao 5.3: +Install Contao {{% siteparam "currentContaoVersion" %}}: ```shell -ddev composer create-project contao/managed-edition:5.3 +ddev composer create-project contao/managed-edition:{{% siteparam "currentContaoVersion" %}} ``` After installation, the database credentials must be entered in the `.env.local`. At the same time, we also set up diff --git a/docs/manual/guides/local-installation/devilbox.de.md b/docs/manual/guides/local-installation/devilbox.de.md index 21cd14bf9..0c3a7d303 100644 --- a/docs/manual/guides/local-installation/devilbox.de.md +++ b/docs/manual/guides/local-installation/devilbox.de.md @@ -167,16 +167,16 @@ Im Anschluss musst du die Devilbox neu starten. Im Devilbox-Hauptverzeichnis lie `shell.bat`. Damit kannst du dich in den laufenden Devilbox PHP-Container (die `Devilbox-shell`) einklinken. Hier sind bereits [zahlreiche Tools](https://devilbox.readthedocs.io/en/latest/readings/available-tools.html) vorinstalliert (unter anderem `Composer`). Nach Aufruf befindest du dich im Container im Verzeichnis `shared/http`. Zur Installation -von z. B. Contao 4.13 in ein Verzeichnis `contao4` musst du lediglich eingeben: +von z. B. Contao {{% siteparam "currentContaoVersion" %}} in ein Verzeichnis `contaocms` musst du lediglich eingeben: ```bash -composer create-project contao/managed-edition contao4 4.13 +composer create-project contao/managed-edition contaocms {{% siteparam "currentContaoVersion" %}} ``` Lege dir eine neue Datenbank an: ```bash -mysql -u root -h mysql -p -e 'CREATE DATABASE db_contao4;' +mysql -u root -h mysql -p -e 'CREATE DATABASE db_contaocms;' ``` {{% notice tip %}} diff --git a/docs/manual/guides/local-installation/devilbox.en.md b/docs/manual/guides/local-installation/devilbox.en.md index 221608538..7f648e235 100644 --- a/docs/manual/guides/local-installation/devilbox.en.md +++ b/docs/manual/guides/local-installation/devilbox.en.md @@ -158,17 +158,17 @@ memory_limit = -1 Afterwards you have to restart the Devilbox. The Devilbox main directory contains the files `shell.sh` and` shell.bat`. So you can plug into the running Devilbox PHP container. Here are already [numerous tools](https://devilbox.readthedocs.io/en/latest/readings/available-tools.html) preinstalled. Also `composer`. -After calling you are in the directory `shared/http`. To install e.g. Contao 4.13 in a directory `contao4` you just +After calling you are in the directory `shared/http`. To install e.g. Contao {{% siteparam "currentContaoVersion" %}} in a directory `contaocms` you just have to enter: ```bash -composer create-project contao/managed-edition contao4 4.13 +composer create-project contao/managed-edition contaocms {{% siteparam "currentContaoVersion" %}} ``` Create a new database: ```bash -mysql -u root -h mysql -p -e 'CREATE DATABASE db_contao4;' +mysql -u root -h mysql -p -e 'CREATE DATABASE db_contaocms;' ``` {{% notice tip %}} diff --git a/docs/manual/guides/local-installation/laragon.de.md b/docs/manual/guides/local-installation/laragon.de.md index 7f17468d9..ea2218219 100644 --- a/docs/manual/guides/local-installation/laragon.de.md +++ b/docs/manual/guides/local-installation/laragon.de.md @@ -248,7 +248,7 @@ Wie bereits erwähnt, kann über das Laragon-Feature »_Neue Website erstellen_ ![Projektname eingeben]({{% asset "images/manual/guides/local-installation/de/laragon/19_laragon_websiteproject_2.png" %}}?width=250px&classes=shadow) -+ Es öffnet sich ein Konsolenfenster: Im Hintergrund wird zunächst Contao {{< current-version >}} (inklusive aller erforderlichen Pakete) via Composer installiert und im Anschluss das Skript des Contao Managers heruntergeladen und im Unterordner `public/` als `contao-manager.phar.php` gespeichert. ++ Es öffnet sich ein Konsolenfenster: Im Hintergrund wird zunächst Contao {{% siteparam "currentContaoVersion" %}} (inklusive aller erforderlichen Pakete) via Composer installiert und im Anschluss das Skript des Contao Managers heruntergeladen und im Unterordner `public/` als `contao-manager.phar.php` gespeichert. + Laragon erstellt darüber hinaus automatisch eine gleichnamige Datenbank »_mycompany_« sowie einen virtuellen Host `mycompany.local` + Für den virtuellen Host muss außerdem die Windows-Hosts-Datei aktualisiert werden. Je nach Konfiguration der Windows-Benutzerkontensteuerung (UAC) wird man daher nach Abschluss der Installation aufgefordert, die Änderungen an der Systemdatei zu bestätigen. Darüber hinaus könnte an dieser Stelle ggf. auch eine Meldung der AntiViren-Software (oder einer anderen Sicherheitssoftware) darauf aufmerksam machen, dass der Zugriff auf die Windows-Hosts-Datei aus Sicherheitsgründen blockiert wird. Sollte das tatsächlich der Fall sein, müsste man zunächst die entsprechende Einstellung in der Sicherheitssoftware temporär deaktivieren und anschließend den Eintrag in der Windows-Hosts-Datei manuell ergänzen. Dazu öffnet man im Laragon-Verwaltungspanel über »_Menü_« > »_Tools_« > »_Bearbeiten drivers\etc\hosts_« die Hosts-Datei im Editor und fügt eine neue Zeile diff --git a/docs/manual/guides/local-installation/laragon.en.md b/docs/manual/guides/local-installation/laragon.en.md index f3ad6cc2f..096151bc9 100644 --- a/docs/manual/guides/local-installation/laragon.en.md +++ b/docs/manual/guides/local-installation/laragon.en.md @@ -287,7 +287,7 @@ not contain any special characters, because it is also used as database name) an ![Enter project name]({{% asset "images/manual/guides/local-installation/en/laragon/19_laragon_websiteproject_2.png" %}}?width=250px&classes=shadow) -- A console window opens: In the background, Contao {{< current-version >}} (including all required packages) is installed via Composer. +- A console window opens: In the background, Contao {{% siteparam "currentContaoVersion" %}} (including all required packages) is installed via Composer. Afterwards, the Contao Manager script is downloaded and saved in the subfolder `public/` as `contao-manager.phar.php`. - Laragon also automatically creates a database of the same name "*mycompany*" and a virtual host `mycompany.local` - For the virtual host, the Windows hosts file must also be updated. Therefore, depending on the Windows User Account diff --git a/docs/manual/installation/install-contao.de.md b/docs/manual/installation/install-contao.de.md index f85e49882..552870c65 100644 --- a/docs/manual/installation/install-contao.de.md +++ b/docs/manual/installation/install-contao.de.md @@ -85,10 +85,10 @@ Wenn du Composer global installierst, kannst du den Befehl `composer` in jedem V ### Contao über die Kommandozeile installieren {#contao-ueber-die-kommandozeile-installieren} Im zweiten Schritt installierst du Contao über den Composer. Dabei steht »example« für das gewünschte -Installations-Verzeichnis und die {{< current-version >}} für die zu [installierende Contao-Version](https://to.contao.org/release-plan). +Installations-Verzeichnis und die {{% siteparam "currentContaoVersion" %}} für die zu [installierende Contao-Version](https://to.contao.org/release-plan). ```bash -php composer.phar create-project contao/managed-edition example {{< current-version >}} +php composer.phar create-project contao/managed-edition example {{% siteparam "currentContaoVersion" %}} ``` diff --git a/docs/manual/installation/install-contao.en.md b/docs/manual/installation/install-contao.en.md index a4283e48d..cd1988873 100644 --- a/docs/manual/installation/install-contao.en.md +++ b/docs/manual/installation/install-contao.en.md @@ -80,10 +80,10 @@ If you install Composer globally, you can use the `composer` command in any dire ### Installing Contao from the command line In the second step, you install Contao using the Composer. "example" stands for the desired installation directory and -{{< current-version >}} for the [version of Contao you want to install](https://to.contao.org/release-plan). +{{% siteparam "currentContaoVersion" %}} for the [version of Contao you want to install](https://to.contao.org/release-plan). ```bash -php composer.phar create-project contao/managed-edition example {{< current-version >}} +php composer.phar create-project contao/managed-edition example {{% siteparam "currentContaoVersion" %}} ``` diff --git a/page/config/_default/params.yml b/page/config/_default/params.yml index 8e69186c5..0ff40673b 100644 --- a/page/config/_default/params.yml +++ b/page/config/_default/params.yml @@ -13,9 +13,8 @@ search: disableLanguageSwitch: true documentation_label: Documentation disableInlineCopyToClipBoard: true -currentContaoLtsVersion: '5.3' currentContaoVersion: '5.6' -currentReleaseCandidate: '5.7' +currentReleaseCandidate: '5.6' disableLandingPageButton: true banner: show: false diff --git a/page/layouts/shortcodes/current-version.html b/page/layouts/shortcodes/current-version.html deleted file mode 100644 index ac031b6c8..000000000 --- a/page/layouts/shortcodes/current-version.html +++ /dev/null @@ -1 +0,0 @@ -{{ .Site.Params.currentContaoVersion }}