[TASK] Introduce directory trees

Releases: main, 12.4

Documentation/Installation/DeployTYPO3.rst

@@ -1,8 +1,8 @@
-.. include:: /Includes.rst.txt
+..  include:: /Includes.rst.txt
 
-.. index:: deployment, composer, production setup
+..  index:: deployment, composer, production setup
 
-.. _deploytypo3:
+..  _deploytypo3:
 
 ===============
 Deploying TYPO3
@@ -20,11 +20,11 @@ necessary.
 General Deployment Steps
 ========================
 
--  Build the local environment (installing everything necessary for the website)
--  Run :bash:`composer install --no-dev` to install without development dependencies
--  Copy files to the production server
--  Copy the database to the production server
--  Clearing the caches
+*   Build the local environment (installing everything necessary for the website)
+*   Run :bash:`composer install --no-dev` to install without development dependencies
+*   Copy files to the production server
+*   Copy the database to the production server
+*   Clearing the caches
 
 .. note::
 
@@ -34,61 +34,70 @@ General Deployment Steps
 
     To avoid conflicts between the local and the server's PHP version,
     the server's PHP version can be defined in the :file:`composer.json` file
-    (e.g. ``{"platform": {"php": "7.4.10"}}``), so Composer will always check
+    (e.g. ``{"platform": {"php": "8.2"}}``), so Composer will always check
     the correct dependencies.
 
 Deployment Automation
 =====================
 
 A typical setup for deploying web applications consists of three different parts:
 
-- The local environment (for development)
-- The build environment (for reproducible builds). This can be a controlled local environment or a remote continuous integration server (for example Gitlab CI or Github Actions)
-- The live (production) environment
+*   The local environment (for development)
+*   The build environment (for reproducible builds). This can be a controlled local environment or a remote continuous integration server (for example Gitlab CI or Github Actions)
+*   The live (production) environment
 
 To get an application from the local environment to the production system, the usage of a deployment tool and/or a continuous integration solution is recommended. This ensures that only version-controlled code is deployed and that builds are reproducible. Ideally setting a new release live will be an atomical operation and lead to no downtime. If there are errors in any of the deployment or test stages, most deployment tools will initiate an automatic "rollback" preventing that an erroneous build is released.
 
 One widely employed strategy is the "symlink-switching" approach:
 
-In that strategy, the webserver serves files from a virtual path :file:`releases/current/public` which consists of a symlink :file:`releases/current` pointing to the latest deployment ("release"). That symlink is switched after a new release has been successfully prepared.
+In that strategy, the webserver serves files from a virtual path :path:`releases/current/public` which consists of a symlink :path:`releases/current` pointing to the latest deployment ("release"). That symlink is switched after a new release has been successfully prepared.
 The latest deployment contains symlinks to folders that should be common among all releases (commonly called "shared folders").
 
 Usually the database is shared between releases and upgrade wizards and schema upgrades are run automatically before or
 shortly after the new release has been set live.
 
 This is an exemplatory directory structure of a "symlink-switching" TYPO3 installation:
 
-.. code-block:: none
-
-    ├── shared/
-    │    ├── fileadmin/
-    │    └── var/
-    │        ├── var/charset/
-    │        ├── var/lock/
-    │        ├── var/log/
-    │        └── var/session/
-    ├── releases/
-    │    ├── current -> ./release1 (symlink to current release)
-    │    └── release1/
-    │        ├── public/ (webserver root, via releases/current/public)
-    │        │   ├── typo3conf/
-    │        │   ├── fileadmin -> ../../../shared/fileadmin/ (symlink)
-    │        │   └── index.php
-    │        ├── var/
-    │        |   ├── var/build/
-    │        |   ├── var/cache/
-    │        |   ├── var/charset -> ../../../shared/var/charset/ (symlink)
-    │        |   ├── var/labels/
-    │        |   ├── var/lock -> ../../../shared/var/lock/ (symlink)
-    │        |   ├── var/log -> ../../../shared/var/log/ (symlink)
-    │        |   └── var/session -> ../../../shared/var/session/ (symlink)
-    │        ├── vendor/
-    │        ├── composer.json
-    │        └── composer.lock
-
-
-The files in `shared` are shared between different releases of a web site.
-The `releases` directory contains the TYPO3 code that will change between the release of each version.
+..  directory-tree::
+
+    *   :path:`shared`
+
+        *   :path:`fileadmin`
+        *   :path:`var`
+
+            *   :path:`charset`
+            *   :path:`lock`
+            *   :path:`log`
+            *   :path:`session`
+
+    *   :path:`releases`
+
+        *   :path:`current -> ./release1` (symlink to current release)
+        *   :path:`release1`
+
+            *   :path:`public` (webserver root, via releases/current/public)
+
+                *   :path:`typo3conf`
+                *   :path:`fileadmin -> ../../../shared/fileadmin` (symlink)
+                *   :file:`index.php`
+
+            *   :path:`var`
+
+                *   :path:`build`
+                *   :path:`cache`
+                *   :path:`charset -> ../../../shared/var/charset` (symlink)
+                *   :path:`labels`
+                *   :path:`lock -> ../../../shared/var/lock` (symlink)
+                *   :path:`log -> ../../../shared/var/log` (symlink)
+                *   :path:`session -> ../../../shared/var/session` (symlink)
+
+            *   :path:`vendor`
+            *   :file:`composer.json`
+            *   :file:`composer.lock`
+
+
+The files in :path:`shared` are shared between different releases of a web site.
+The :path:`releases` directory contains the TYPO3 code that will change between the release of each version.
 
 When using a deployment tool this kind of directory structure is usually created automatically.
 

Documentation/Installation/Install.rst

@@ -76,20 +76,19 @@ This command pulls down the latest release of the given TYPO3 version and places
 it in the :file:`example-project-directory/`.
 
 After this command has finished running, the :file:`example-project-directory/`
-folder contains the following files and folders, where :file:`var/` 
+folder contains the following files and folders, where :file:`var/`
 is added after the first login into the TYPO3 backend:
 
-..  code-block:: text
+..  directory-tree::
 
-    .
-    ├── .gitignore
-    ├── composer.json
-    ├── composer.lock
-    ├── LICENSE
-    ├── public
-    ├── README.md
-    ├── var
-    └── vendor
+    *   :path:`public`
+    *   :path:`var`
+    *   :path:`vendor`
+    *   :file:`.gitignore`
+    *   :file:`composer.json`
+    *   :file:`composer.lock`
+    *   :file:`LICENSE`
+    *   :file:`README.md`
 
 
 Run the setup process
@@ -156,18 +155,20 @@ Create an empty file called `FIRST_INSTALL` in the `public/` directory:
 
             ddev exec touch public/FIRST_INSTALL
 
-..  code-block:: text
-
-    .
-    ├── .gitignore
-    ├── composer.json
-    ├── composer.lock
-    ├── LICENSE
-    ├── public
-        └── FIRST_INSTALL
-    ├── README.md
-    ├── var
-    └── vendor
+
+..  directory-tree::
+
+    *   :path:`public`
+
+        *   :file:`FIRST_INSTALL`
+
+    *   :path:`var`
+    *   :path:`vendor`
+    *   :file:`.gitignore`
+    *   :file:`composer.json`
+    *   :file:`composer.lock`
+    *   :file:`LICENSE`
+    *   :file:`README.md`
 
 ..  _install-access-typo3-via-a-web-browser:
 

Documentation/Installation/LegacyInstallation.rst

@@ -54,17 +54,18 @@ Installing on a Unix Server
 
    .. important::
       Make sure to upload the whole TYPO3 source directory including the
-      :file:`vendor` directory, otherwise you will miss important dependencies.
+      :path:`vendor` directory, otherwise you will miss important dependencies.
 
 #. This will then create the following structure:
 
-   .. code-block:: none
+..  directory-tree::
 
-    ├── typo3_src-13.x.y/
-    ├── public/
-    ├── ── typo3_src -> ../typo3_src-13.x.y/
-    ├── ── typo3 -> typo3_src/typo3/
-    ├── ── index.php -> typo3_src/index.php
+    *   :path:`typo3_src-13.x.y/`
+    *   :path:`public/`
+
+        *   :path:`typo3_src -> ../typo3_src-13.x.y/`
+        *   :path:`typo3 -> typo3_src/typo3/`
+        *   :file:`index.php -> typo3_src/index.php`
 
 Installing on a Windows Server
 ==============================
@@ -87,13 +88,14 @@ Installing on a Windows Server
 
 #. This will then create the following structure:
 
-   .. code-block:: none
+    ..  directory-tree::
+
+        *   :path:`typo3_src-13.x.y/`
+        *   :path:`public/`
 
-    ├── typo3_src-13.x.y/
-    ├── public/
-    ├── ── typo3_src -> ../typo3_src-13.x.y/
-    ├── ── typo3 -> typo3_src/typo3/
-    ├── ── index.php -> typo3_src/index.php
+            *   :path:`typo3_src -> ../typo3_src-13.x.y/`
+            *   :path:`typo3 -> typo3_src/typo3/`
+            *   :file:`index.php -> typo3_src/index.php`
 
 
 Completing The Installation