Skip to content

Commit

Permalink
Fix spelling errors & broken/outdated links (#335)
Browse files Browse the repository at this point in the history
  • Loading branch information
sandoba authored May 11, 2024
1 parent 26cf562 commit 5cf6f4a
Show file tree
Hide file tree
Showing 21 changed files with 39 additions and 40 deletions.
4 changes: 2 additions & 2 deletions Documentation/About.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://typo3.org/teams-committees/>`__
* General information on how you can `Participate <https://typo3.org/participate/>`__
* General information about the various `Teams & Committees <https://typo3.org/community/teams/>`__
* General information on how you can `Contribute and Get Involved <https://typo3.org/community/contribute/>`__

.. _contribute:

Expand Down
4 changes: 2 additions & 2 deletions Documentation/Account/GerritAccount.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Setting up Gerrit (ssh)
:ref:`set up earlier <TYPO3Account>`.


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:
Expand All @@ -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`.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Account/Slack.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://my.typo3.org/index.php?id=35>`__.
2. Go to `Slack for TYPO3 on my.typo3.org <https://my.typo3.org/index.php?id=35>`__.

On that page, you will also find information about recommended channels.

Expand Down
7 changes: 3 additions & 4 deletions Documentation/Appendix/CommitHook.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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<commitmessage>`.

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

Expand All @@ -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 <https://gitforwindows.org/>`__.
* 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 <https://gitforwindows.org/>`__.

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
Expand Down
6 changes: 3 additions & 3 deletions Documentation/Appendix/HowToDeprecateThings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <extension-scanner>` whenever possible.

Here is how:
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -228,7 +228,7 @@ Example:
* not be converted back to <link> 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, <link> syntax is deprecated
*/
Expand Down
4 changes: 2 additions & 2 deletions Documentation/Appendix/IdePhpStormSetup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ EditorConfig
Please note that there is an
`.editorconfig <https://github.com/typo3/typo3/blob/main/.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
<https://plugins.jetbrains.com/plugin/7294-editorconfig>`__ for PhpStorm.

If you use the :file:`.editorconfig` file (which is included in the TYPO3 core), some
Expand All @@ -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 <t3coreapi:cgl>`
for more information and toolchain configuration. Please read
for more information and toolchain configuration. Please read
`PhpStorm documentation on using PHP CS Fixer <https://www.jetbrains.com/help/phpstorm/using-php-cs-fixer.html#installing-configuring-php-cs-fixer>`__
for information on how to use the provided
`config.php <https://github.com/TYPO3/typo3/blob/main/Build/php-cs-fixer/config.php>`__
Expand Down
4 changes: 2 additions & 2 deletions Documentation/Appendix/Linux/SettingUpTypo3ManuallyLinux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Prerequisites
=============

You will need a Webserver, PHP and database on your system. Look at the page `System requirements
<https://typo3.org/typo3-cms/overview/requirements/>`__ and check out the specific system
requirements for the current main branch on the `Download TYPO3 <https://typo3.org/download/>`__
<https://get.typo3.org/version/12#system-requirements>`__ and check out the specific system
requirements for the current main branch on the `Download TYPO3 <https://get.typo3.org/>`__
page.

Just as a minimal example, this is a list of packages you might want to
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Appendix/OSX/GitTower.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
=========================================
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Appendix/ResourcesForEditors/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Appendix/SettingUpTypo3Ddev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
single: Setup; DDEV

.. _ddev:
.. _settting-up-typo3-with-ddev:
.. _setting-up-typo3-with-ddev:

.. warning::

Expand Down
4 changes: 2 additions & 2 deletions Documentation/Appendix/SettingUpTypo3Manually.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Prerequisites
=============

You will need a Webserver, PHP and database on your system. Look at the page `System requirements
<https://typo3.org/typo3-cms/overview/requirements/>`__ and also check out the specific system
requirements for the current main branch on the `Download TYPO3 <https://typo3.org/download/>`__
<https://get.typo3.org/version/12#system-requirements>`__ and also check out the specific system
requirements for the current main branch on the `Download TYPO3 <https://get.typo3.org/>`__
page.

You will need to set up the prerequisites for your operating system. Look at the following for guidance:
Expand Down
6 changes: 3 additions & 3 deletions Documentation/Appendix/Windows/Troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Documentation/BugfixingAZ/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ as described in :ref:`setup <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 <changelog>`.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/HandlingAPatch/FindAReview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.



Expand Down
4 changes: 2 additions & 2 deletions Documentation/HandlingAPatch/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Documentation/HandlingAPatch/Review.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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<coreMergers-review>`.
for more details.

Expand Down
6 changes: 3 additions & 3 deletions Documentation/ReportingAnIssue/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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!).


Expand Down
2 changes: 1 addition & 1 deletion Documentation/Setup/SetupIde.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions Documentation/Setup/SetupTypo3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ Setup the TYPO3 installation

.. rst-class:: horizbuttons-primary-m

- :ref:`DDEV <settting-up-typo3-with-ddev>`
- :ref:`DDEV <setting-up-typo3-with-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 <settting-up-typo3-with-ddev>`
* :ref:`DDEV <setting-up-typo3-with-ddev>`
* :ref:`setting-up-typo3-manually`

In any case, use the cloned Git repository as basis (see :ref:`git-clone`).
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Testing/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ You should see something like this message:
See `Get Started, Part 1: Orientation and setup <https://docs.docker.com/get-started/#test-docker-version>`__

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
<https://docs.docker.com/docker-for-mac/troubleshoot/>`__

Results
Expand Down
8 changes: 4 additions & 4 deletions Documentation/Troubleshooting/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 5cf6f4a

Please sign in to comment.