|
6 | 6 |
|
7 | 7 | .. _quickstart-prerequisites: |
8 | 8 |
|
| 9 | +========================== |
9 | 10 | Quick Start: Prerequisites |
10 | 11 | ========================== |
11 | 12 |
|
12 | 13 | We will not explain you how to set up the following prerequisites. |
13 | 14 | There are several tutorials for this on the web, and if you follow |
14 | 15 | the Quick Start guide, you should know how to do this. |
15 | 16 |
|
16 | | -.. rst-class:: bignums-xxl |
| 17 | +.. contents:: |
| 18 | + |
| 19 | +.. _quickstart-prerequisites-operating-system: |
| 20 | + |
| 21 | +Operating System |
| 22 | +================ |
| 23 | + |
| 24 | +A computer running Windows with WSL2, macOS or Linux - connected to |
| 25 | +the Internet. |
| 26 | + |
| 27 | +.. _quickstart-prerequisites-docker: |
17 | 28 |
|
18 | | -1. Operating System |
| 29 | +Docker |
| 30 | +====== |
19 | 31 |
|
20 | | - A computer running Windows with WSL2, macOS or Linux - connected to |
21 | | - the Internet. |
| 32 | +Either the "original" `Docker Desktop <https://www.docker.com/products/docker-desktop/>`__ |
| 33 | +or an alternative like `OrbStack <https://orbstack.dev/>`__, `Podman <https://podman.io/>`__, |
| 34 | +`Colima <https://github.com/abiosoft/colima>`__ or others. Linux users |
| 35 | +do not need to install any `Desktop` variants, but can use their base |
| 36 | +Docker or Podman setup. |
22 | 37 |
|
23 | | -2. Docker |
| 38 | +.. _quickstart-prerequisites-ddev: |
24 | 39 |
|
25 | | - Either the "original" `Docker Desktop <https://www.docker.com/products/docker-desktop/>`__ |
26 | | - or an alternative like `OrbStack <https://orbstack.dev/>`__, `Podman <https://podman.io/>`__, |
27 | | - `Colima <https://github.com/abiosoft/colima>`__ or others. Linux users |
28 | | - do not need to install any `Desktop` variants, but can use their base |
29 | | - Docker or Podman setup. |
| 40 | +DDEV |
| 41 | +==== |
30 | 42 |
|
31 | | -3. DDEV |
| 43 | +`DDEV <https://ddev.com>`__ is a layer on top of Docker. How to utilize it is |
| 44 | +covered in this guide. |
32 | 45 |
|
33 | | - `DDEV <https://ddev.com>`__ is a layer on top of Docker. How to utilize it is |
34 | | - covered in this guide. |
| 46 | +.. _quickstart-prerequisites-terminal: |
35 | 47 |
|
36 | | -4. Terminal (Bash) |
| 48 | +Terminal (Bash) |
| 49 | +=============== |
37 | 50 |
|
38 | | - Your operating system needs to provide a Bash terminal, many steps of this guide |
39 | | - will be executed on the shell. |
| 51 | +Your operating system needs to provide a Bash terminal, many steps of this guide |
| 52 | +will be executed on the shell. |
40 | 53 |
|
41 | | - You are free to use another local shell for your work, but the scripts |
42 | | - provided by the TYPO3 Core (most importantly `runTests.sh`) require Bash |
43 | | - to be available. |
| 54 | +You are free to use another local shell for your work, but the scripts |
| 55 | +provided by the TYPO3 Core (most importantly `runTests.sh`) require Bash |
| 56 | +to be available. |
44 | 57 |
|
45 | | -5. Git client |
| 58 | +.. _quickstart-prerequisites-git-client: |
46 | 59 |
|
47 | | - This guide expects you can execute `git` terminal commands. |
| 60 | +Git client |
| 61 | +========== |
48 | 62 |
|
49 | | - This guide uses the *https* method to connect to GitHub, so you do not |
50 | | - need to have a GitHub account. |
| 63 | +This guide expects you can execute `git` terminal commands. |
51 | 64 |
|
52 | | -6. SSH client plus SSH key(s) and an email account |
| 65 | +This guide uses the *https* method to connect to GitHub, so you do not |
| 66 | +need to have a GitHub account. |
53 | 67 |
|
54 | | - This guide expects you can execute `ssh` terminal commands and connect to |
55 | | - foreign hosts. You will need a private SSH key pair and know how to authenticate |
56 | | - with it. You need an email account to setup accounts. |
| 68 | +.. _quickstart-prerequisites-ssh: |
57 | 69 |
|
58 | | -7. PHP IDE / Editor |
| 70 | +SSH client plus SSH key(s) and an email account |
| 71 | +=============================================== |
59 | 72 |
|
60 | | - It is recommended to use a good PHP IDE. As part of the target audience of this guide |
61 | | - you should already use something like PhpStorm, Visual Studio Code, vi(m)... |
| 73 | +This guide expects you can execute `ssh` terminal commands and connect to |
| 74 | +foreign hosts. You will need a private SSH key pair and know how to authenticate |
| 75 | +with it. You need an email account to setup accounts. |
| 76 | + |
| 77 | +.. _quickstart-prerequisites-ide: |
| 78 | + |
| 79 | +PHP IDE / Editor |
| 80 | +================ |
| 81 | + |
| 82 | +It is recommended to use a good PHP IDE. As part of the target audience of this guide |
| 83 | +you should already use something like PhpStorm, Visual Studio Code, vi(m)... |
62 | 84 |
|
63 | 85 | .. _quickstart-assumptions: |
64 | | -8. Assumed path structure and name usage |
65 | 86 |
|
66 | | - We will use: |
| 87 | +Assumed path structure and name usage |
| 88 | +===================================== |
| 89 | + |
| 90 | +We will use: |
67 | 91 |
|
68 | | - * **$HOME/work/TYPO3-Contribute/** as your working directory (created in the guide). |
69 | | - * **John Doe** to be your name. |
70 | | - * ** [email protected]** to be your email address that you used for all accounts. |
71 | | - * **john-doe** to be your TYPO3.org username. |
72 | | - * A TYPO3 **legacy mode** installation (Non-Composer) with MariaDB 10.11 and PHP 8.2. |
| 92 | +* **$HOME/work/TYPO3-Contribute/** as your working directory (created in the guide). |
| 93 | +* **John Doe** to be your name. |
| 94 | +* ** [email protected]** to be your email address that you used for all accounts. |
| 95 | +* **john-doe** to be your TYPO3.org username. |
| 96 | +* A TYPO3 **legacy mode** installation (Non-Composer) with MariaDB 10.11 and PHP 8.2. |
73 | 97 |
|
74 | | - Adjust any occurences of this to match your environment. |
| 98 | +Adjust any occurences of this to match your environment. |
0 commit comments