diff --git a/Documentation/About.rst b/Documentation/About.rst index 63945c25..1d2d15c5 100644 --- a/Documentation/About.rst +++ b/Documentation/About.rst @@ -69,8 +69,8 @@ Besides developing for the TYPO3 core, there are many other ways to contribute a You can find general information here: -* General information about the various `Teams & Committes `__ -* General information on how you can `Participate `__ +* General information about the various `Teams & Committees `__ +* General information on how you can `Contribute and Get Involved `__ .. _contribute: diff --git a/Documentation/Account/GerritAccount.rst b/Documentation/Account/GerritAccount.rst index 454cb0c9..2f88f57f 100644 --- a/Documentation/Account/GerritAccount.rst +++ b/Documentation/Account/GerritAccount.rst @@ -25,7 +25,7 @@ Setting up Gerrit (ssh) :ref:`set up earlier `. -2. Create your ssh key +2. Create your SSH key If you don't know how to create your SSH Public/Private Key, we have compiled a list of links for you: @@ -44,7 +44,7 @@ Setting up Gerrit (ssh) * On the left hand side, click :guilabel:`SSH Keys`. - * Copy-paste the contents of your public ssh key file (e.g. + * Copy-paste the contents of your public SSH key file (e.g. :file:`~/.ssh/id_rsa.pub`) into the text field next to :guilabel:`New SSH key` and then click on :guilabel:`Add new SSH key`. diff --git a/Documentation/Account/Slack.rst b/Documentation/Account/Slack.rst index 16db30f1..665df06d 100644 --- a/Documentation/Account/Slack.rst +++ b/Documentation/Account/Slack.rst @@ -29,7 +29,7 @@ Register for Slack account In order to join the slack workspace, you must already have your typo3.org account. -2. Got to `Slack for TYPO3 on my.typo3.org `__. +2. Go to `Slack for TYPO3 on my.typo3.org `__. On that page, you will also find information about recommended channels. diff --git a/Documentation/Appendix/CommitHook.rst b/Documentation/Appendix/CommitHook.rst index 05d397cf..d328e6d5 100644 --- a/Documentation/Appendix/CommitHook.rst +++ b/Documentation/Appendix/CommitHook.rst @@ -37,7 +37,7 @@ a Change-Id on your own, the result will be chaos. Apart from that the hook will check your commit message for logical errors like missing keywords, Resolves lines etc. For detailed information on the format of a commit message, :ref:`click here`. -If the commit-msg hook finds errors in your commit-msg, you can try again, by ammending to the commit:: +If the commit-msg hook finds errors in your commit-msg, you can try again, by amending to the commit:: git commit --amend @@ -54,15 +54,14 @@ If the commit-msg hook finds errors in your commit-msg, you can try again, by am * File: :file:`.git/hooks/pre-commit` * Source file: :file:`Build/git-hooks/unix+mac/pre-commit` -* This hook is optional. **This hook is not available for Windows.**, however it can executed on Windows machines by using a tool like the `Git BASH `__. +* This hook is optional. **This hook is not available for Windows.**, however it can be executed on Windows machines by using a tool like the `Git BASH `__. The :file:`pre-commit` hook checks all added PHP files staged for the commit for Coding Guideline issues and will report any problems it finds. To fix the issues, see :ref:`cgl-fix-my-commit`. -After fixing the files you must amend your -commit: +After fixing the files you must amend your commit: .. code-block:: bash diff --git a/Documentation/Appendix/HowToDeprecateThings.rst b/Documentation/Appendix/HowToDeprecateThings.rst index 9925bb20..35263f8f 100644 --- a/Documentation/Appendix/HowToDeprecateThings.rst +++ b/Documentation/Appendix/HowToDeprecateThings.rst @@ -15,7 +15,7 @@ In that grace period a deprecation warning will be thrown. If you want to remove or change functionality in the TYPO3 Core, it has to be deprecated first. .. note:: - Up on deprecating or removing functionality the change must be added + Upon deprecating or removing functionality the change must be added to the :ref:`Extension scanner ` whenever possible. Here is how: @@ -98,7 +98,7 @@ the future: #. Add the :php:`TYPO3\CMS\Core\Compatibility\PublicPropertyDeprecationTrait` trait to the class. -#. Add the property :php:`$deprecatedPublicMethods` to the class and list all properties that +#. Add the property :php:`$deprecatedPublicProperties` to the class and list all properties that should no longer be accessed from outside of the class. #. Make the property private/protected. @@ -228,7 +228,7 @@ Example: * not be converted back to tags anymore. * * @param string $value Content input - * @param bool $internallyCalledFromCore internal option for calls where the Core is still using this function, to supress method deprecations + * @param bool $internallyCalledFromCore internal option for calls where the Core is still using this function, to suppress method deprecations * @return string Content output * @deprecated will be removed in TYPO3 v10, only ->TS_AtagToAbs() should be called directly, syntax is deprecated */ diff --git a/Documentation/Appendix/IdePhpStormSetup.rst b/Documentation/Appendix/IdePhpStormSetup.rst index 72865400..d17754d5 100644 --- a/Documentation/Appendix/IdePhpStormSetup.rst +++ b/Documentation/Appendix/IdePhpStormSetup.rst @@ -49,7 +49,7 @@ EditorConfig Please note that there is an `.editorconfig `__ file in the TYPO3 core repository. -See http://EditorConfig.org for more information. Use the `EditorConfig plugin +See https://editorconfig.org/ for more information. Use the `EditorConfig plugin `__ for PhpStorm. If you use the :file:`.editorconfig` file (which is included in the TYPO3 core), some @@ -58,7 +58,7 @@ standard formatting rules are already setup automatically (e.g. indent with The rules defined in :file:`.editorconfig` are very minimal and it is suggested to see the :ref:`TYPO3 Coding Guidelines ` -for more information and toolchain configuration. Please read +for more information and toolchain configuration. Please read `PhpStorm documentation on using PHP CS Fixer `__ for information on how to use the provided `config.php `__ diff --git a/Documentation/Appendix/Linux/SettingUpTypo3ManuallyLinux.rst b/Documentation/Appendix/Linux/SettingUpTypo3ManuallyLinux.rst index fa6a8712..17267df6 100644 --- a/Documentation/Appendix/Linux/SettingUpTypo3ManuallyLinux.rst +++ b/Documentation/Appendix/Linux/SettingUpTypo3ManuallyLinux.rst @@ -14,8 +14,8 @@ Prerequisites ============= You will need a Webserver, PHP and database on your system. Look at the page `System requirements -`__ and check out the specific system -requirements for the current main branch on the `Download TYPO3 `__ +`__ and check out the specific system +requirements for the current main branch on the `Download TYPO3 `__ page. Just as a minimal example, this is a list of packages you might want to diff --git a/Documentation/Appendix/OSX/GitTower.rst b/Documentation/Appendix/OSX/GitTower.rst index e7a547a2..58a72bfc 100644 --- a/Documentation/Appendix/OSX/GitTower.rst +++ b/Documentation/Appendix/OSX/GitTower.rst @@ -22,7 +22,7 @@ Tower provides extended support for Gerrit_, which comes in handy because we wor Although it is a paid product, we think the cost is absolutely worth it. -You can learn more about Git Tower on their website http://www.git-tower.com/. +You can learn more about Git Tower on their website https://www.git-tower.com/. Enabling Extended Gerrit Support in Tower ========================================= diff --git a/Documentation/Appendix/ResourcesForEditors/Index.rst b/Documentation/Appendix/ResourcesForEditors/Index.rst index 1c8af18d..f9b6f94a 100644 --- a/Documentation/Appendix/ResourcesForEditors/Index.rst +++ b/Documentation/Appendix/ResourcesForEditors/Index.rst @@ -32,7 +32,7 @@ Hints for creating images ~~~~~~~~~~~~~~~~~~~~~~~~~ Do not create huge fullscreen images. If an image contains too much information, -try to highlight the significant information by usinng boxes, text, numbers and / or +try to highlight the significant information by using boxes, text, numbers and / or arrows in the image. Add a white border inside the image if it helps the image to stand out from the text. diff --git a/Documentation/Appendix/SettingUpTypo3Ddev.rst b/Documentation/Appendix/SettingUpTypo3Ddev.rst index e5f5635d..7308b49d 100644 --- a/Documentation/Appendix/SettingUpTypo3Ddev.rst +++ b/Documentation/Appendix/SettingUpTypo3Ddev.rst @@ -8,7 +8,7 @@ single: Setup; DDEV .. _ddev: -.. _settting-up-typo3-with-ddev: +.. _setting-up-typo3-with-ddev: .. warning:: diff --git a/Documentation/Appendix/SettingUpTypo3Manually.rst b/Documentation/Appendix/SettingUpTypo3Manually.rst index 609fe064..79864195 100644 --- a/Documentation/Appendix/SettingUpTypo3Manually.rst +++ b/Documentation/Appendix/SettingUpTypo3Manually.rst @@ -12,8 +12,8 @@ Prerequisites ============= You will need a Webserver, PHP and database on your system. Look at the page `System requirements -`__ and also check out the specific system -requirements for the current main branch on the `Download TYPO3 `__ +`__ and also check out the specific system +requirements for the current main branch on the `Download TYPO3 `__ page. You will need to set up the prerequisites for your operating system. Look at the following for guidance: diff --git a/Documentation/Appendix/Windows/Troubleshooting.rst b/Documentation/Appendix/Windows/Troubleshooting.rst index 4bb1ad22..c9c16d08 100644 --- a/Documentation/Appendix/Windows/Troubleshooting.rst +++ b/Documentation/Appendix/Windows/Troubleshooting.rst @@ -27,19 +27,19 @@ If you try to push to gerrit and you keep getting the following error message Permission denied (publickey). fatal: Could not read from remote repository. -Checklist for ssh problems +Checklist for SSH problems ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rst-class:: bignums-xxl -1. Make sure the **public** SSH key is stored in your Gerrit Acccount +1. Make sure the **public** SSH key is stored in your Gerrit account. See :ref:`GerritAccount` 2. Check if your **private** SSH key is in the correct OpenSSH format. You can export your SSH key to the correct OpenSSH format with the Putty Key - Generator with Conversions -> Export OpenSSH Key -> safe with a filename, + Generator with Conversions -> Export OpenSSH Key -> save with a filename, but without a file ending! 3. Check if the ssh-agent is running or turn it on diff --git a/Documentation/BugfixingAZ/Index.rst b/Documentation/BugfixingAZ/Index.rst index 364f142b..192470e9 100644 --- a/Documentation/BugfixingAZ/Index.rst +++ b/Documentation/BugfixingAZ/Index.rst @@ -65,7 +65,7 @@ as described in :ref:`setup `. Especially the there is ancient code we didn't have to touch yet because it just works. Make sure to look at :ref:`deprecations` in the Appendix for information - about to deprecate things if you need to make changes to the public API. + about how to deprecate things if you need to make changes to the public API. For new features, breaking changes and deprecations, it is necessary to :ref:`add information to the changelog `. diff --git a/Documentation/HandlingAPatch/FindAReview.rst b/Documentation/HandlingAPatch/FindAReview.rst index fe928a47..73f8f236 100644 --- a/Documentation/HandlingAPatch/FindAReview.rst +++ b/Documentation/HandlingAPatch/FindAReview.rst @@ -45,7 +45,7 @@ Email notification If you are in any way involved in the review (e.g. you are author, reviewer or you made changes), you will get a notification about -it to your email adress. The notification contains a link. +it to your email address. The notification contains a link. diff --git a/Documentation/HandlingAPatch/Index.rst b/Documentation/HandlingAPatch/Index.rst index 498db161..71f0a977 100644 --- a/Documentation/HandlingAPatch/Index.rst +++ b/Documentation/HandlingAPatch/Index.rst @@ -27,10 +27,10 @@ Every patch contains a single commit. If changes are made to a patch, the alread commit is changed (:code:`git commit --amend`). How to do this is explained in :ref:`lifeOfAPatch-improve-patch` -To make sure, every patch applied to the TYPO3 codebase meets highest standards, +To make sure, every patch applied to the TYPO3 codebase meets the highest standards, every patch must be reviewed. Only after at least 2 people have tested the patch and at least 2 people have verified it (one of them must be a member of the core team), can -the patch be merged (for more details on voting, see :ref:`gerrit-voting`. +the patch be merged (for more details on voting, see :ref:`gerrit-voting`). Additionally, a suite of tests (unit, functional and acceptance) will automatically run on every patch (set), the results being shown as a +1 or diff --git a/Documentation/HandlingAPatch/Review.rst b/Documentation/HandlingAPatch/Review.rst index 2ed0454c..d9ee3982 100644 --- a/Documentation/HandlingAPatch/Review.rst +++ b/Documentation/HandlingAPatch/Review.rst @@ -137,7 +137,7 @@ and enter your comment. Here, you can also apply your votes. .. sidebar:: Votes - The :guilabel:`+2` and :guilabel:`-2` votes only available for Core Mergers. + The :guilabel:`+2` and :guilabel:`-2` votes are only available for Core Mergers. See the section :ref:`Review a patch as a Core Merger`. for more details. diff --git a/Documentation/ReportingAnIssue/Index.rst b/Documentation/ReportingAnIssue/Index.rst index 54892218..9781e2ff 100644 --- a/Documentation/ReportingAnIssue/Index.rst +++ b/Documentation/ReportingAnIssue/Index.rst @@ -276,7 +276,7 @@ A good bug report should contain all or any of these elements: Here you can add: * A brief description of your environment. Depending on the nature of - the bug it *might* inclde your operating system + the bug it *might* include your operating system (Windows, Linux, macOS, ...), the full version of TYPO3, the webserver used, the database used (mySql, SQLServer, ...) and its version. In any case, the full version of TYPO3 (e.g. 9.5.1) is very helpful. If @@ -299,7 +299,7 @@ A good bug report should contain all or any of these elements: #. Actual results This is the heart of your problem: what happened after you followed the - steps? Please add also here if your problem is repeteable or comes out + steps? Please add also here if your problem is repeatable or comes out randomly. #. Expected results @@ -318,7 +318,7 @@ the bug. .. tip:: Use redmine formatting to structure your bug report and make it more readable, for - example use headlines (h1, h2) to structure the parts, hightlighted code (<>) for + example use headlines (h1, h2) to structure the parts, highlighted code (<>) for code snippets, code for inline images (!image!). diff --git a/Documentation/Setup/SetupIde.rst b/Documentation/Setup/SetupIde.rst index 25fa0594..faeb5c7b 100644 --- a/Documentation/Setup/SetupIde.rst +++ b/Documentation/Setup/SetupIde.rst @@ -28,7 +28,7 @@ Coding Guidelines ----------------- There is an .editorconfig file in the TYPO3 core repository. -See http://EditorConfig.org for more information. +See https://editorconfig.org/ for more information. Please note that the rules in :file:`.editorconfig` are very minimal. So, additionally, setup your editor / IDE to use the recommendation as described in the diff --git a/Documentation/Setup/SetupTypo3.rst b/Documentation/Setup/SetupTypo3.rst index c631979d..8922a4af 100644 --- a/Documentation/Setup/SetupTypo3.rst +++ b/Documentation/Setup/SetupTypo3.rst @@ -15,13 +15,13 @@ Setup the TYPO3 installation .. rst-class:: horizbuttons-primary-m - - :ref:`DDEV ` + - :ref:`DDEV ` You will now need to setup a working installation of TYPO3. There are different ways how you can do this. We provide a few examples in the Appendix: -* :ref:`DDEV ` +* :ref:`DDEV ` * :ref:`setting-up-typo3-manually` In any case, use the cloned Git repository as basis (see :ref:`git-clone`). diff --git a/Documentation/Testing/Index.rst b/Documentation/Testing/Index.rst index 66f5ff53..f42c02a2 100644 --- a/Documentation/Testing/Index.rst +++ b/Documentation/Testing/Index.rst @@ -250,7 +250,7 @@ You should see something like this message: See `Get Started, Part 1: Orientation and setup `__ Also, see docker troubleshooting pages for more in-depth information, -such as `Docker for Mac: Logs and troublehooting +such as `Docker for Mac: Logs and troubleshooting `__ Results diff --git a/Documentation/Troubleshooting/Index.rst b/Documentation/Troubleshooting/Index.rst index 2e8f2a83..3cdd2554 100644 --- a/Documentation/Troubleshooting/Index.rst +++ b/Documentation/Troubleshooting/Index.rst @@ -87,7 +87,7 @@ If the output looks like this, everything is fine: Connection to review.typo3.org closed. Otherwise, your SSH client does not automatically choose the right private key file. -By default, ssh searches for the key in :file:`~/.ssh/id_rsa` and :file:`~/.ssh/id_dsa`. +By default, SSH searches for the key in :file:`~/.ssh/id_rsa` and :file:`~/.ssh/id_dsa`. You can manually specify it using the -i parameter: @@ -110,7 +110,7 @@ connections to review.typo3.org: Now the connection should work without having to specify any parameters as described above. If this does not work another issue might be that your SSH version is too new and does not -accept the signature algorithm . You can test this by executing: +accept the signature algorithm. You can test this by executing: .. code-block:: bash :caption: shell command @@ -166,7 +166,7 @@ You are not a committer If you are trying to push changes and get this error message, then your email address is probably not known to the system. Open Settings > Identities in Gerrit and check the email address, which is connected to your account -(you can add more of them if needed). Additionally, check your setttings in +(you can add more of them if needed). Additionally, check your settings in Git with the following command: .. code-block:: bash @@ -267,7 +267,7 @@ Even without modifying the Commit Message, it gets a new SHA. This commit can be Resolving Merge Conflicts in generated asset files -------------------------------------------------- -If you cherry pick a patch for review; you might encounter a mergeconflict with a generated asset file: +If you cherry pick a patch for review; you might encounter a merge conflict with a generated asset file: .. code-block:: none :caption: result