Skip to content

Commit 10a2619

Browse files
authored
Update header levels
Updated formatting and structure of prerequisites section.
1 parent 8e55d2d commit 10a2619

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

Documentation/Quickstart/1-Preqrequisites.rst

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
.. _quickstart-prerequisites:
88

9+
==========================
910
Quick Start: Prerequisites
1011
==========================
1112

@@ -16,15 +17,17 @@ the Quick Start guide, you should know how to do this.
1617
.. contents::
1718

1819
.. _quickstart-prerequisites-operating-system:
20+
1921
Operating System
20-
----------------
22+
================
2123

2224
A computer running Windows with WSL2, macOS or Linux - connected to
2325
the Internet.
2426

2527
.. _quickstart-prerequisites-docker:
28+
2629
Docker
27-
------
30+
======
2831

2932
Either the "original" `Docker Desktop <https://www.docker.com/products/docker-desktop/>`__
3033
or an alternative like `OrbStack <https://orbstack.dev/>`__, `Podman <https://podman.io/>`__,
@@ -33,15 +36,17 @@ do not need to install any `Desktop` variants, but can use their base
3336
Docker or Podman setup.
3437

3538
.. _quickstart-prerequisites-ddev:
39+
3640
DDEV
37-
----
41+
====
3842

3943
`DDEV <https://ddev.com>`__ is a layer on top of Docker. How to utilize it is
4044
covered in this guide.
4145

4246
.. _quickstart-prerequisites-terminal:
47+
4348
Terminal (Bash)
44-
---------------
49+
===============
4550

4651
Your operating system needs to provide a Bash terminal, many steps of this guide
4752
will be executed on the shell.
@@ -51,32 +56,36 @@ provided by the TYPO3 Core (most importantly `runTests.sh`) require Bash
5156
to be available.
5257

5358
.. _quickstart-prerequisites-git-client:
59+
5460
Git client
55-
----------
61+
==========
5662

5763
This guide expects you can execute `git` terminal commands.
5864

5965
This guide uses the *https* method to connect to GitHub, so you do not
6066
need to have a GitHub account.
6167

6268
.. _quickstart-prerequisites-ssh:
69+
6370
SSH client plus SSH key(s) and an email account
64-
-----------------------------------------------
71+
===============================================
6572

6673
This guide expects you can execute `ssh` terminal commands and connect to
6774
foreign hosts. You will need a private SSH key pair and know how to authenticate
6875
with it. You need an email account to setup accounts.
6976

7077
.. _quickstart-prerequisites-ide:
78+
7179
PHP IDE / Editor
72-
----------------
80+
================
7381

7482
It is recommended to use a good PHP IDE. As part of the target audience of this guide
7583
you should already use something like PhpStorm, Visual Studio Code, vi(m)...
7684

7785
.. _quickstart-assumptions:
86+
7887
Assumed path structure and name usage
79-
-------------------------------------
88+
=====================================
8089

8190
We will use:
8291

0 commit comments

Comments
 (0)