diff --git a/Documentation/Quickstart/1-Preqrequisites.rst b/Documentation/Quickstart/1-Preqrequisites.rst index ba95581..a2fb2fe 100644 --- a/Documentation/Quickstart/1-Preqrequisites.rst +++ b/Documentation/Quickstart/1-Preqrequisites.rst @@ -6,6 +6,7 @@ .. _quickstart-prerequisites: +========================== Quick Start: Prerequisites ========================== @@ -13,62 +14,85 @@ 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 +.. contents:: + +.. _quickstart-prerequisites-operating-system: + +Operating System +================ + +A computer running Windows with WSL2, macOS or Linux - connected to +the Internet. + +.. _quickstart-prerequisites-docker: -1. Operating System +Docker +====== - A computer running Windows with WSL2, macOS or Linux - connected to - the Internet. +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. -2. Docker +.. _quickstart-prerequisites-ddev: - 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. +.. _quickstart-prerequisites-terminal: -4. Terminal (Bash) +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. -5. Git client +.. _quickstart-prerequisites-git-client: - This guide expects you can execute `git` terminal commands. +Git client +========== - This guide uses the *https* method to connect to GitHub, so you do not - need to have a GitHub account. +This guide expects you can execute `git` terminal commands. -6. SSH client plus SSH key(s) and an email account +This guide uses the *https* method to connect to GitHub, so you do not +need to have a GitHub 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-ssh: -7. PHP IDE / Editor +SSH client plus SSH key(s) and an email account +=============================================== - 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)... +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: -8. Assumed path structure and name usage - We will use: +Assumed path structure and name usage +===================================== + +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.