Skip to content

Commit 8686880

Browse files
Adjust headline structure in quick start section prerequisites
1 parent 38742b2 commit 8686880

File tree

1 file changed

+45
-39
lines changed

1 file changed

+45
-39
lines changed

Documentation/Quickstart/1-Preqrequisites.rst

Lines changed: 45 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -13,62 +13,68 @@ We will not explain you how to set up the following prerequisites.
1313
There are several tutorials for this on the web, and if you follow
1414
the Quick Start guide, you should know how to do this.
1515

16-
.. rst-class:: bignums-xxl
16+
Operating System
17+
----------------
1718

18-
1. Operating System
19+
A computer running Windows with WSL2, macOS or Linux - connected to
20+
the Internet.
1921

20-
A computer running Windows with WSL2, macOS or Linux - connected to
21-
the Internet.
22+
Docker
23+
------
2224

23-
2. Docker
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.
2430

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.
31+
DDEV
32+
----
3033

31-
3. DDEV
34+
`DDEV <https://ddev.com>`__ is a layer on top of Docker. How to utilize it is
35+
covered in this guide.
3236

33-
`DDEV <https://ddev.com>`__ is a layer on top of Docker. How to utilize it is
34-
covered in this guide.
37+
Terminal (Bash)
38+
---------------
3539

36-
4. Terminal (Bash)
40+
Your operating system needs to provide a Bash terminal, many steps of this guide
41+
will be executed on the shell.
3742

38-
Your operating system needs to provide a Bash terminal, many steps of this guide
39-
will be executed on the shell.
43+
You are free to use another local shell for your work, but the scripts
44+
provided by the TYPO3 Core (most importantly `runTests.sh`) require Bash
45+
to be available.
4046

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.
47+
Git client
48+
----------
4449

45-
5. Git client
50+
This guide expects you can execute `git` terminal commands.
4651

47-
This guide expects you can execute `git` terminal commands.
52+
This guide uses the *https* method to connect to GitHub, so you do not
53+
need to have a GitHub account.
4854

49-
This guide uses the *https* method to connect to GitHub, so you do not
50-
need to have a GitHub account.
55+
SSH client plus SSH key(s) and an email account
56+
-----------------------------------------------
5157

52-
6. SSH client plus SSH key(s) and an email account
58+
This guide expects you can execute `ssh` terminal commands and connect to
59+
foreign hosts. You will need a private SSH key pair and know how to authenticate
60+
with it. You need an email account to setup accounts.
5361

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.
62+
PHP IDE / Editor
63+
----------------
5764

58-
7. PHP IDE / Editor
59-
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)...
65+
It is recommended to use a good PHP IDE. As part of the target audience of this guide
66+
you should already use something like PhpStorm, Visual Studio Code, vi(m)...
6267

6368
.. _quickstart-assumptions:
64-
8. Assumed path structure and name usage
69+
Assumed path structure and name usage
70+
-------------------------------------
6571

66-
We will use:
72+
We will use:
6773

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.
74+
* **$HOME/work/TYPO3-Contribute/** as your working directory (created in the guide).
75+
* **John Doe** to be your name.
76+
* **[email protected]** to be your email address that you used for all accounts.
77+
* **john-doe** to be your TYPO3.org username.
78+
* A TYPO3 **legacy mode** installation (Non-Composer) with MariaDB 10.11 and PHP 8.2.
7379

74-
Adjust any occurences of this to match your environment.
80+
Adjust any occurences of this to match your environment.

0 commit comments

Comments
 (0)