From 868688015d2639da91483e340659168be0954db0 Mon Sep 17 00:00:00 2001 From: Julian Schuierer Date: Wed, 12 Nov 2025 15:51:06 +0100 Subject: [PATCH 1/3] Adjust headline structure in quick start section prerequisites --- Documentation/Quickstart/1-Preqrequisites.rst | 84 ++++++++++--------- 1 file changed, 45 insertions(+), 39 deletions(-) diff --git a/Documentation/Quickstart/1-Preqrequisites.rst b/Documentation/Quickstart/1-Preqrequisites.rst index ba95581c..55bee075 100644 --- a/Documentation/Quickstart/1-Preqrequisites.rst +++ b/Documentation/Quickstart/1-Preqrequisites.rst @@ -13,62 +13,68 @@ We will not explain you how to set up the following prerequisites. There are several tutorials for this on the web, and if you follow the Quick Start guide, you should know how to do this. -.. rst-class:: bignums-xxl +Operating System +---------------- -1. Operating System +A computer running Windows with WSL2, macOS or Linux - connected to +the Internet. - A computer running Windows with WSL2, macOS or Linux - connected to - the Internet. +Docker +------ -2. Docker +Either the "original" `Docker Desktop `__ +or an alternative like `OrbStack `__, `Podman `__, +`Colima `__ or others. Linux users +do not need to install any `Desktop` variants, but can use their base +Docker or Podman setup. - Either the "original" `Docker Desktop `__ - or an alternative like `OrbStack `__, `Podman `__, - `Colima `__ or others. Linux users - do not need to install any `Desktop` variants, but can use their base - Docker or Podman setup. +DDEV +---- -3. DDEV +`DDEV `__ is a layer on top of Docker. How to utilize it is +covered in this guide. - `DDEV `__ is a layer on top of Docker. How to utilize it is - covered in this guide. +Terminal (Bash) +--------------- -4. Terminal (Bash) +Your operating system needs to provide a Bash terminal, many steps of this guide +will be executed on the shell. - Your operating system needs to provide a Bash terminal, many steps of this guide - will be executed on the shell. +You are free to use another local shell for your work, but the scripts +provided by the TYPO3 Core (most importantly `runTests.sh`) require Bash +to be available. - You are free to use another local shell for your work, but the scripts - provided by the TYPO3 Core (most importantly `runTests.sh`) require Bash - to be available. +Git client +---------- -5. Git client +This guide expects you can execute `git` terminal commands. - This guide expects you can execute `git` terminal commands. +This guide uses the *https* method to connect to GitHub, so you do not +need to have a GitHub account. - This guide uses the *https* method to connect to GitHub, so you do not - need to have a GitHub account. +SSH client plus SSH key(s) and an email account +----------------------------------------------- -6. SSH client plus SSH key(s) and an email account +This guide expects you can execute `ssh` terminal commands and connect to +foreign hosts. You will need a private SSH key pair and know how to authenticate +with it. You need an email account to setup accounts. - This guide expects you can execute `ssh` terminal commands and connect to - foreign hosts. You will need a private SSH key pair and know how to authenticate - with it. You need an email account to setup accounts. +PHP IDE / Editor +---------------- -7. PHP IDE / Editor - - It is recommended to use a good PHP IDE. As part of the target audience of this guide - you should already use something like PhpStorm, Visual Studio Code, vi(m)... +It is recommended to use a good PHP IDE. As part of the target audience of this guide +you should already use something like PhpStorm, Visual Studio Code, vi(m)... .. _quickstart-assumptions: -8. Assumed path structure and name usage +Assumed path structure and name usage +------------------------------------- - We will use: +We will use: - * **$HOME/work/TYPO3-Contribute/** as your working directory (created in the guide). - * **John Doe** to be your name. - * **john.doe@example.com** to be your email address that you used for all accounts. - * **john-doe** to be your TYPO3.org username. - * A TYPO3 **legacy mode** installation (Non-Composer) with MariaDB 10.11 and PHP 8.2. +* **$HOME/work/TYPO3-Contribute/** as your working directory (created in the guide). +* **John Doe** to be your name. +* **john.doe@example.com** to be your email address that you used for all accounts. +* **john-doe** to be your TYPO3.org username. +* A TYPO3 **legacy mode** installation (Non-Composer) with MariaDB 10.11 and PHP 8.2. - Adjust any occurences of this to match your environment. +Adjust any occurences of this to match your environment. From 8e55d2dc52df8280d23ca3f65fe7a7435204d077 Mon Sep 17 00:00:00 2001 From: Julian Schuierer Date: Wed, 12 Nov 2025 16:20:45 +0100 Subject: [PATCH 2/3] Add missing table of contents and headline anchors --- Documentation/Quickstart/1-Preqrequisites.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Documentation/Quickstart/1-Preqrequisites.rst b/Documentation/Quickstart/1-Preqrequisites.rst index 55bee075..3284e643 100644 --- a/Documentation/Quickstart/1-Preqrequisites.rst +++ b/Documentation/Quickstart/1-Preqrequisites.rst @@ -13,12 +13,16 @@ We will not explain you how to set up the following prerequisites. There are several tutorials for this on the web, and if you follow the Quick Start guide, you should know how to do this. +.. contents:: + +.. _quickstart-prerequisites-operating-system: Operating System ---------------- A computer running Windows with WSL2, macOS or Linux - connected to the Internet. +.. _quickstart-prerequisites-docker: Docker ------ @@ -28,12 +32,14 @@ or an alternative like `OrbStack `__, `Podman `__ is a layer on top of Docker. How to utilize it is covered in this guide. +.. _quickstart-prerequisites-terminal: Terminal (Bash) --------------- @@ -44,6 +50,7 @@ You are free to use another local shell for your work, but the scripts provided by the TYPO3 Core (most importantly `runTests.sh`) require Bash to be available. +.. _quickstart-prerequisites-git-client: Git client ---------- @@ -52,6 +59,7 @@ This guide expects you can execute `git` terminal commands. This guide uses the *https* method to connect to GitHub, so you do not need to have a GitHub account. +.. _quickstart-prerequisites-ssh: SSH client plus SSH key(s) and an email account ----------------------------------------------- @@ -59,6 +67,7 @@ This guide expects you can execute `ssh` terminal commands and connect to foreign hosts. You will need a private SSH key pair and know how to authenticate with it. You need an email account to setup accounts. +.. _quickstart-prerequisites-ide: PHP IDE / Editor ---------------- From 10a2619f080fd6811c923d8a2d0812891f38a21f Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Wed, 12 Nov 2025 16:27:07 +0100 Subject: [PATCH 3/3] Update header levels Updated formatting and structure of prerequisites section. --- Documentation/Quickstart/1-Preqrequisites.rst | 25 +++++++++++++------ 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/Documentation/Quickstart/1-Preqrequisites.rst b/Documentation/Quickstart/1-Preqrequisites.rst index 3284e643..a2fb2fe1 100644 --- a/Documentation/Quickstart/1-Preqrequisites.rst +++ b/Documentation/Quickstart/1-Preqrequisites.rst @@ -6,6 +6,7 @@ .. _quickstart-prerequisites: +========================== Quick Start: Prerequisites ========================== @@ -16,15 +17,17 @@ the Quick Start guide, you should know how to do this. .. contents:: .. _quickstart-prerequisites-operating-system: + Operating System ----------------- +================ A computer running Windows with WSL2, macOS or Linux - connected to the Internet. .. _quickstart-prerequisites-docker: + Docker ------- +====== Either the "original" `Docker Desktop `__ or an alternative like `OrbStack `__, `Podman `__, @@ -33,15 +36,17 @@ do not need to install any `Desktop` variants, but can use their base Docker or Podman setup. .. _quickstart-prerequisites-ddev: + DDEV ----- +==== `DDEV `__ is a layer on top of Docker. How to utilize it is covered in this guide. .. _quickstart-prerequisites-terminal: + Terminal (Bash) ---------------- +=============== Your operating system needs to provide a Bash terminal, many steps of this guide will be executed on the shell. @@ -51,8 +56,9 @@ provided by the TYPO3 Core (most importantly `runTests.sh`) require Bash to be available. .. _quickstart-prerequisites-git-client: + Git client ----------- +========== This guide expects you can execute `git` terminal commands. @@ -60,23 +66,26 @@ This guide uses the *https* method to connect to GitHub, so you do not need to have a GitHub account. .. _quickstart-prerequisites-ssh: + SSH client plus SSH key(s) and an email account ------------------------------------------------ +=============================================== This guide expects you can execute `ssh` terminal commands and connect to foreign hosts. You will need a private SSH key pair and know how to authenticate with it. You need an email account to setup accounts. .. _quickstart-prerequisites-ide: + PHP IDE / Editor ----------------- +================ It is recommended to use a good PHP IDE. As part of the target audience of this guide you should already use something like PhpStorm, Visual Studio Code, vi(m)... .. _quickstart-assumptions: + Assumed path structure and name usage -------------------------------------- +===================================== We will use: