Skip to content

Prevent rendering issue with anchor between list items #403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
linawolf merged 3 commits into from
Nov 12, 2025
Merged

Prevent rendering issue with anchor between list items #403

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8686880
Adjust headline structure in quick start section prerequisites
Julian-Schuierer Nov 12, 2025
8e55d2d
Add missing table of contents and headline anchors
Julian-Schuierer Nov 12, 2025
10a2619
Update header levels
linawolf Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 62 additions & 38 deletions Documentation/Quickstart/1-Preqrequisites.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,69 +6,93 @@

.. _quickstart-prerequisites:

==========================
Quick Start: Prerequisites
==========================

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 <https://www.docker.com/products/docker-desktop/>`__
or an alternative like `OrbStack <https://orbstack.dev/>`__, `Podman <https://podman.io/>`__,
`Colima <https://github.com/abiosoft/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 <https://www.docker.com/products/docker-desktop/>`__
or an alternative like `OrbStack <https://orbstack.dev/>`__, `Podman <https://podman.io/>`__,
`Colima <https://github.com/abiosoft/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 <https://ddev.com>`__ is a layer on top of Docker. How to utilize it is
covered in this guide.

`DDEV <https://ddev.com>`__ 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.