From ce4e3a265bffc63ffb40fc316fa658585130b172 Mon Sep 17 00:00:00 2001 From: Kiebele Date: Tue, 5 Nov 2024 14:33:25 +0100 Subject: [PATCH 1/6] [Task] Description about how to find extensions and renaming management --- .../Extensions/HowToFindExtensions.rst | 75 +++++++++++++++++++ Documentation/Extensions/Index.rst | 13 ++-- ...anagement.rst => InstallingExtensions.rst} | 11 +-- 3 files changed, 85 insertions(+), 14 deletions(-) create mode 100644 Documentation/Extensions/HowToFindExtensions.rst rename Documentation/Extensions/{Management.rst => InstallingExtensions.rst} (97%) diff --git a/Documentation/Extensions/HowToFindExtensions.rst b/Documentation/Extensions/HowToFindExtensions.rst new file mode 100644 index 00000000..9e0d0020 --- /dev/null +++ b/Documentation/Extensions/HowToFindExtensions.rst @@ -0,0 +1,75 @@ +.. include:: /Includes.rst.txt + +.. _how-to-find-extensions: + +====================== +How to find extensions +====================== + +For beginners, finding the right extensions can enhance their TYPO3 experience +significantly. Here is a brief guide on how to search for extensions and where +to find the necessary information. + +#. `TYPO3 Extension Repository (TER) `__ + + The TYPO3 Extension Repository (TER) is online platform, that hosts + thousands of extensions created by the TYPO3 Community. + Here you can: + + * Search by keyword + * Explore categories + * Filter results + +#. `Packagist `__ + + Packagist serves as the default package repository for PHP packages using Composer, + including TYPO3 extensions. You can search for TYPO3 extensions on Packagist + by entering relevant keywords. Many TYPO3 extensions are available via Composer, + which allows for easier dependency management and installation. This is + particularly useful for developers looking to integrate extensions into + their projects. + + +.. _tips-for-choosing-extensions: + +Tips for Choosing the right TYPO3 Extension +=========================================== + +Selecting the right extension is essential for ensuring that it meets your needs +and integrates well into your TYPO3 setup. Here are a few key factors to consider: + +* Compatibility: + + Verify that the extension is compatible with your version of TYPO3. + The TER and Packagist often display compatibility information. Choosing an + incompatible extension can lead to errors or unexpected issues. + +* Popularity and reviews: + + Extensions that are frequently used and have good reviews are often more + reliable. Look at download numbers, ratings, and user feedback in the TER + or on GitHub to get a sense of the extension’s quality. + +* Support and updates: + + Check if the extension is actively maintained and updated to work with the + latest TYPO3 versions. An extension with recent updates is more likely to + be secure and compatible with modern TYPO3 standards. + +* Documentation: + + Good documentation is essential, especially for beginners. Ensure that the + extension has clear setup and configuration guides, either in the TER, on + the developer's website, or on GitHub. + +* Performance and security: + + Extensions can affect your site’s performance, so choose extensions that + are optimized and well-coded. Additionally, check for any reported security + vulnerabilities, particularly for older extensions, to keep your site secure. + +* Customizability and flexibility: + + If you have specific needs, ensure that the extension is flexible enough to + be customized or configured as required. Some extensions provide hooks or + APIs, which are beneficial for custom development. diff --git a/Documentation/Extensions/Index.rst b/Documentation/Extensions/Index.rst index a2658a95..6bd5f242 100644 --- a/Documentation/Extensions/Index.rst +++ b/Documentation/Extensions/Index.rst @@ -13,14 +13,13 @@ Working With Extensions :class: pb-4 :card-height: 100 - .. card:: :ref:`Managing Extensions ` + .. card:: :ref:`How to find extensions ` - Information on how to find, install and manage extensions using Composer. + Information on how to find extensions and what to consider when choosing. - .. card:: :ref:`Installing local extensions ` + .. card:: :ref:`Installing Extensions ` - Information on how to install local extensions including site packages and custom - extensions using Composer. + Information on how to install extensions using Composer. .. card:: :ref:`Managing Extensions - Legacy Guide ` @@ -37,7 +36,7 @@ Working With Extensions :hidden: :titlesonly: - Management - Installing Local Extensions + HowToFindExtensions + InstallingExtensions LegacyManagement CreateOwnExtension diff --git a/Documentation/Extensions/Management.rst b/Documentation/Extensions/InstallingExtensions.rst similarity index 97% rename from Documentation/Extensions/Management.rst rename to Documentation/Extensions/InstallingExtensions.rst index 57ce75d2..dd7e8e9b 100644 --- a/Documentation/Extensions/Management.rst +++ b/Documentation/Extensions/InstallingExtensions.rst @@ -1,10 +1,10 @@ .. include:: /Includes.rst.txt -.. _extensions_management: +.. _installing-extensions: -=================== -Managing Extensions -=================== +===================== +Installing Extensions +===================== Both system extensions and third-party extensions are managed using Composer. Composer handles the installation of the extension and also installs any dependencies that may be @@ -12,9 +12,6 @@ required. Composer is also used to uninstall extensions. .. _install-extension-with-composer: -Installing extensions -===================== - Find the Composer package name for an extension ----------------------------------------------- From 7c0790f0dc8d9e3c3a7fe094800a854b28767f3a Mon Sep 17 00:00:00 2001 From: mkiebele <84334387+mkiebele@users.noreply.github.com> Date: Wed, 6 Nov 2024 08:57:25 +0100 Subject: [PATCH 2/6] Update Documentation/Extensions/InstallingExtensions.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/Extensions/InstallingExtensions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Extensions/InstallingExtensions.rst b/Documentation/Extensions/InstallingExtensions.rst index dd7e8e9b..04e95842 100644 --- a/Documentation/Extensions/InstallingExtensions.rst +++ b/Documentation/Extensions/InstallingExtensions.rst @@ -3,7 +3,7 @@ .. _installing-extensions: ===================== -Installing Extensions +Installing extensions ===================== Both system extensions and third-party extensions are managed using Composer. Composer handles From 3c9e2875648e4066f6237a17d54d05c4636263a5 Mon Sep 17 00:00:00 2001 From: mkiebele <84334387+mkiebele@users.noreply.github.com> Date: Wed, 6 Nov 2024 08:57:32 +0100 Subject: [PATCH 3/6] Update Documentation/Extensions/HowToFindExtensions.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/Extensions/HowToFindExtensions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Extensions/HowToFindExtensions.rst b/Documentation/Extensions/HowToFindExtensions.rst index 9e0d0020..4afb37aa 100644 --- a/Documentation/Extensions/HowToFindExtensions.rst +++ b/Documentation/Extensions/HowToFindExtensions.rst @@ -12,7 +12,7 @@ to find the necessary information. #. `TYPO3 Extension Repository (TER) `__ - The TYPO3 Extension Repository (TER) is online platform, that hosts + The TYPO3 Extension Repository (TER) is an online platform, that hosts thousands of extensions created by the TYPO3 Community. Here you can: From 2dfedb6ce84d48735d724df5493cf08b22f90782 Mon Sep 17 00:00:00 2001 From: mkiebele <84334387+mkiebele@users.noreply.github.com> Date: Wed, 6 Nov 2024 08:57:38 +0100 Subject: [PATCH 4/6] Update Documentation/Extensions/HowToFindExtensions.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/Extensions/HowToFindExtensions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Extensions/HowToFindExtensions.rst b/Documentation/Extensions/HowToFindExtensions.rst index 4afb37aa..6a1a1d92 100644 --- a/Documentation/Extensions/HowToFindExtensions.rst +++ b/Documentation/Extensions/HowToFindExtensions.rst @@ -32,7 +32,7 @@ to find the necessary information. .. _tips-for-choosing-extensions: -Tips for Choosing the right TYPO3 Extension +Tips for choosing the right TYPO3 extension =========================================== Selecting the right extension is essential for ensuring that it meets your needs From ac54fc07f0e7680f3f07c5c71a91bcba84e5990f Mon Sep 17 00:00:00 2001 From: mkiebele <84334387+mkiebele@users.noreply.github.com> Date: Wed, 6 Nov 2024 08:57:47 +0100 Subject: [PATCH 5/6] Update Documentation/Extensions/HowToFindExtensions.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/Extensions/HowToFindExtensions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Extensions/HowToFindExtensions.rst b/Documentation/Extensions/HowToFindExtensions.rst index 6a1a1d92..c815cf32 100644 --- a/Documentation/Extensions/HowToFindExtensions.rst +++ b/Documentation/Extensions/HowToFindExtensions.rst @@ -71,5 +71,5 @@ and integrates well into your TYPO3 setup. Here are a few key factors to conside * Customizability and flexibility: If you have specific needs, ensure that the extension is flexible enough to - be customized or configured as required. Some extensions provide hooks or + be customized or configured as required. Some extensions provide PSR-14 events or APIs, which are beneficial for custom development. From 964ff8b4695d868069bb082a0692cdaee2a43a9b Mon Sep 17 00:00:00 2001 From: Kiebele Date: Wed, 6 Nov 2024 09:15:37 +0100 Subject: [PATCH 6/6] [FIX] Description about packagist adapted --- Documentation/Extensions/HowToFindExtensions.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/Extensions/HowToFindExtensions.rst b/Documentation/Extensions/HowToFindExtensions.rst index c815cf32..4c248efe 100644 --- a/Documentation/Extensions/HowToFindExtensions.rst +++ b/Documentation/Extensions/HowToFindExtensions.rst @@ -24,10 +24,10 @@ to find the necessary information. Packagist serves as the default package repository for PHP packages using Composer, including TYPO3 extensions. You can search for TYPO3 extensions on Packagist - by entering relevant keywords. Many TYPO3 extensions are available via Composer, - which allows for easier dependency management and installation. This is - particularly useful for developers looking to integrate extensions into - their projects. + by entering relevant keywords or filter for extensions to narrow down your + results. Many TYPO3 extensions are available via Composer, which allows for + easier dependency management and installation. This is particularly useful + for developers looking to integrate extensions into their projects. .. _tips-for-choosing-extensions: