Skip to content

Commit

Permalink
[TASK] Add third-party tools chapter with information on Rector (#271)
Browse files Browse the repository at this point in the history
* [TASK] Add third-party tools chapter with information on Rector

This commit adds a new section to the Upgrade Guide
titled "third party tools".

The first being TYPO3 Rector.

[+] Add "Third-party Tools" section with card
[+] Add information about T3 Rector

* Remove link to main Rector repository page

* Change title

* Change Slack link

* Update Index.rst
  • Loading branch information
tomwarwick committed Dec 15, 2021
1 parent 34ebaf2 commit ae2e09a
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
14 changes: 14 additions & 0 deletions Documentation/Index.rst
Expand Up @@ -49,6 +49,19 @@ Upgrading TYPO3
Just like TYPO3's core, extensions also need to be regularly updated.
This chapter details how to upgrade extensions using Composer.

.. container:: col-md-6 pl-0 pr-3 py-3 m-0

.. container:: card px-0 h-100

.. rst-class:: card-header h3

.. rubric:: :ref:`Third-party Tools <Tools>`

.. container:: card-body

Tools and resources developed by the community that can assist with common
upgrade and maintenance tasks.

.. container:: col-md-6 pl-0 pr-3 py-3 m-0

.. container:: card px-0 h-100
Expand Down Expand Up @@ -92,6 +105,7 @@ Upgrading TYPO3
Minor/Index
Major/Index
UpgradingExtensions/Index
Tools/Index
Legacy/Index
MigrateToComposer/Index
MigrateContent/Index
Expand Down
32 changes: 32 additions & 0 deletions Documentation/Tools/Index.rst
@@ -0,0 +1,32 @@
.. include:: /Includes.rst.txt

.. _tools:

=================
Third-party tools
=================

A collection of third-party resources that can assist with upgrade and
maintenance tasks.

Rector for TYPO3
================

Rector for TYPO3 was created to help developers upgrade their TYPO3 installations
and ensure their extensions support the latest versions of PHP and TYPO3. Rector
scans your code base and replaces any deprecated functions with an appropriate
replacement. Rector can also help ensure better code quality by means of automated refactoring.

Rector can run as a standalone package or it can be integrated with your CI pipeline.

Resources
---------

- `Rector for TYPO3 GitHub page <https://github.com/sabbelasichon/typo3-rector>`__.
- `Best practice guide <https://github.com/sabbelasichon/typo3-rector/blob/main/docs/best_practice_guide.md>`__.

Support
-------

Visit the `TYPO3 Slack <https://typo3.org/community/meet/chat-slack>`__ and search for the `#ext-typo3-rector`
channel. You can also open an issue or start a discussion on the projects GitHub page.

0 comments on commit ae2e09a

Please sign in to comment.