[TASK] Fix typo and formatting in documentation for #84545 73/61873/4
authorTymoteusz Motylewski <t.motylewski@gmail.com>
Wed, 2 Oct 2019 08:28:25 +0000 (10:28 +0200)
committerAndreas Fernandez <a.fernandez@scripting-base.de>
Wed, 2 Oct 2019 13:47:02 +0000 (15:47 +0200)
* Fix typo in folder name.
* Format lists properly.
* Add missing text roles.

Resolves: #89329
Releases: master, 9.5
Change-Id: I0b48404729dca49c4049dfb7b83c5248b887f791
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/61873
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Markus Klein <markus.klein@typo3.org>
Tested-by: Björn Jacob <bjoern.jacob@tritum.de>
Tested-by: Andreas Fernandez <a.fernandez@scripting-base.de>
Reviewed-by: Oliver Klee <typo3-coding@oliverklee.de>
Reviewed-by: Markus Klein <markus.klein@typo3.org>
Reviewed-by: Björn Jacob <bjoern.jacob@tritum.de>
Reviewed-by: Andreas Fernandez <a.fernandez@scripting-base.de>

index a51aa2d..e5bd795 100644 (file)
@@ -9,7 +9,7 @@ See :issue:`84545`
-The environment variable called `TYPO3_PATH_APP`, which was previously introduced with the Environment API, is now used
+The environment variable called :php:`TYPO3_PATH_APP`, which was previously introduced with the Environment API, is now used
 to allow to store data outside of the document root.
 All regular composer-based installations now benefit from this functionality directly, as data which was previously
@@ -20,10 +20,12 @@ upwards than the regular **web root**. This increases security for any TYPO3 ins
 publicly accessible (for example via web browser) anymore.
 A typical example:
-- `TYPO3_PATH_APP` is set to :file:`/var/www/my-project`.
-- The web folder is then set to `TYPO3_PATH_ROOT` :file:`/var/www/my-project/public`.
+- :php:`TYPO3_PATH_APP` is set to :file:`/var/www/my-project`.
+- The web folder is then set to :php:`TYPO3_PATH_ROOT` :file:`/var/www/my-project/public`.
 Non-public files are then put to
 - :file:`/var/www/my-project/var/session` (like Maintenance Tool Session files)
 - :file:`/var/www/my-project/var/cache` (Caching Framework data)
 - :file:`/var/www/my-project/var/lock` (Files related to locking)
@@ -42,13 +44,14 @@ For installations having the environment variable set, the folder is now not wit
 but outside of the document root in a folder called :file:`var/`.
 For installations without this setting in use, there are minor differences in the folder structure:
 - :file:`typo3temp/var/cache` is now used instead of :file:`typo3temp/var/Cache`
-- :file:`typo3temp/var/log` is now used instead of :file:`typo3temp/var/log`
+- :file:`typo3temp/var/log` is now used instead of :file:`typo3temp/var/logs`
 - :file:`typo3temp/var/lock` is now used instead of :file:`typo3temp/var/locks`
 - :file:`typo3temp/var/session` is now used instead of :file:`typo3temp/var/InstallToolSessions`
 - :file:`typo3temp/var/extensionmanager` is now used instead of :file:`typo3temp/var/ExtensionManager`
-Although it is a most common understanding in the TYPO3 world that `typo3temp/` can be removed at any time,
+Although it is a most common understanding in the TYPO3 world that :file:`typo3temp/` can be removed at any time,
 it is considered bad practice to remove the whole folder. Only folders relevant for the current development
 changes should selectively be removed.