Skip to content

Commit 6532f25

Browse files
authored
Merge branch 'main' into feature/recommended-extensions
2 parents 2b23c90 + 784e2c8 commit 6532f25

File tree

6 files changed

+143
-170
lines changed

6 files changed

+143
-170
lines changed
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
.. include:: /Includes.rst.txt
2+
3+
.. _how-to-find-extensions:
4+
5+
======================
6+
How to find extensions
7+
======================
8+
9+
For beginners, finding the right extensions can enhance their TYPO3 experience
10+
significantly. Here is a brief guide on how to search for extensions and where
11+
to find the necessary information.
12+
13+
#. `TYPO3 Extension Repository (TER) <https://extensions.typo3.org/>`__
14+
15+
The TYPO3 Extension Repository (TER) is an online platform, that hosts
16+
thousands of extensions created by the TYPO3 Community.
17+
Here you can:
18+
19+
* Search by keyword
20+
* Explore categories
21+
* Filter results
22+
23+
#. `Packagist <https://packagist.org//>`__
24+
25+
Packagist serves as the default package repository for PHP packages using Composer,
26+
including TYPO3 extensions. You can search for TYPO3 extensions on Packagist
27+
by entering relevant keywords or filter for extensions to narrow down your
28+
results. Many TYPO3 extensions are available via Composer, which allows for
29+
easier dependency management and installation. This is particularly useful
30+
for developers looking to integrate extensions into their projects.
31+
32+
33+
.. _tips-for-choosing-extensions:
34+
35+
Tips for choosing the right TYPO3 extension
36+
===========================================
37+
38+
Selecting the right extension is essential for ensuring that it meets your needs
39+
and integrates well into your TYPO3 setup. Here are a few key factors to consider:
40+
41+
* Compatibility:
42+
43+
Verify that the extension is compatible with your version of TYPO3.
44+
The TER and Packagist often display compatibility information. Choosing an
45+
incompatible extension can lead to errors or unexpected issues.
46+
47+
* Popularity and reviews:
48+
49+
Extensions that are frequently used and have good reviews are often more
50+
reliable. Look at download numbers, ratings, and user feedback in the TER
51+
or on GitHub to get a sense of the extension’s quality.
52+
53+
* Support and updates:
54+
55+
Check if the extension is actively maintained and updated to work with the
56+
latest TYPO3 versions. An extension with recent updates is more likely to
57+
be secure and compatible with modern TYPO3 standards.
58+
59+
* Documentation:
60+
61+
Good documentation is essential, especially for beginners. Ensure that the
62+
extension has clear setup and configuration guides, either in the TER, on
63+
the developer's website, or on GitHub.
64+
65+
* Performance and security:
66+
67+
Extensions can affect your site’s performance, so choose extensions that
68+
are optimized and well-coded. Additionally, check for any reported security
69+
vulnerabilities, particularly for older extensions, to keep your site secure.
70+
71+
* Customizability and flexibility:
72+
73+
If you have specific needs, ensure that the extension is flexible enough to
74+
be customized or configured as required. Some extensions provide PSR-14 events or
75+
APIs, which are beneficial for custom development.

Documentation/Extensions/Index.rst

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,37 +13,27 @@ Working With Extensions
1313
:class: pb-4
1414
:card-height: 100
1515

16-
.. card:: :ref:`Managing Extensions <extensions_management>`
16+
.. card:: :ref:`How to find extensions <how-to-find-extensions>`
1717

18-
Information on how to find, install and manage extensions using Composer.
18+
Information on how to find extensions and what to consider when choosing.
1919

20-
.. card:: :ref:`Installing local extensions <install_local_extensions_using_composer>`
20+
.. card:: :ref:`Installing Extensions <installing-extensions>`
2121

22-
Information on how to install local extensions including site packages and custom
23-
extensions using Composer.
22+
Information on how to install extensions using Composer.
2423

25-
.. card:: :ref:`Managing Extensions - Legacy Guide <extensions_legacy_management>`
24+
.. card:: :ref:`Recommended extensions <recommended-extensions>`
2625

27-
This guide contains information on how to manage extensions using the
28-
TYPO3 backend and the TYPO3 Extension Repository (TER) without Composer.
29-
This method of managing extensions is now deprecated.
26+
An overview of recommended extensions.
3027

3128
.. card:: :ref:`Create your own extension <create-own-extension>`
3229

3330
This guide contains information on how to create your own extension.
3431

35-
.. card:: :ref:`Recommended extensions <recommended-extensions>`
36-
37-
An overview of recommended extensions.
38-
39-
4032
.. toctree::
4133
:hidden:
4234
:titlesonly:
4335

44-
Management
45-
Installing Local Extensions <https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/Extensions/Management.html#installing-local-extensions>
46-
LegacyManagement
47-
CreateOwnExtension
36+
HowToFindExtensions
37+
InstallingExtensions
4838
RecommendedExtensions
49-
39+
CreateOwnExtension

Documentation/Extensions/Management.rst renamed to Documentation/Extensions/InstallingExtensions.rst

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
11
.. include:: /Includes.rst.txt
22

3-
.. _extensions_management:
3+
.. _installing-extensions:
44

5-
===================
6-
Managing Extensions
7-
===================
5+
=====================
6+
Installing extensions
7+
=====================
88

99
Both system extensions and third-party extensions are managed using Composer. Composer handles
1010
the installation of the extension and also installs any dependencies that may be
1111
required. Composer is also used to uninstall extensions.
1212

1313
.. _install-extension-with-composer:
1414

15-
Installing extensions
16-
=====================
17-
1815
Find the Composer package name for an extension
1916
-----------------------------------------------
2017

Documentation/Extensions/LegacyManagement.rst

Lines changed: 0 additions & 144 deletions
This file was deleted.
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
.. include:: /Includes.rst.txt
2+
3+
.. _creating-a-site-package:
4+
5+
=======================
6+
Creating a site package
7+
=======================
8+
9+
The next step is to create a site package. In TYPO3, a site package is a
10+
structured package that organizes the layout, design, and essential
11+
configuration settings for your website. By using a site package, you can
12+
manage all customizations in one place, which keeps your changes organized and
13+
makes your project easier to maintain, even through TYPO3 updates.
14+
15+
.. _how-to-create-a-site-package:
16+
17+
How to create a site package
18+
============================
19+
20+
To create a site package, you have two main options:
21+
22+
* Manual creation: For full control over your project's setup, you can follow
23+
the detailed instructions int the
24+
:ref:`TYPO3 site package tutorial <t3sitepackage:start>`.
25+
26+
* Using the `Sitepackage-Builder <https://www.sitepackagebuilder.com/>`__:
27+
If you are looking for a faster start, the Sitepackage-Builder is a
28+
handy tool. You can choose whether your site package should be based on
29+
the `Bootstrap Package <https://www.bootstrap-package.com/>`__ or
30+
:ref:`fluid_styled_content <typo3/cms-fluid-styled-content:introduction>`.
31+
32+
33+
.. _pros-and-cons-of-sitepackage-builder:
34+
35+
Pros and cons of using the Sitepackage-Builder
36+
==============================================
37+
38+
Pros:
39+
40+
* The Sitepackage-Builder is particularly useful for beginners or projects
41+
that need a quick start.
42+
43+
Cons:
44+
45+
* A large number of unnecessary, mostly empty files are being generated.
46+
* Depending on your prior knowledge you use code that you might not fully
47+
understand.

Documentation/FirstProject/Index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,13 @@ First project setup
4747
.. card-footer:: :ref:`Manage settings <settings>`
4848
:button-style: btn btn-secondary stretched-link
4949

50+
.. card:: :ref:`Creating a site package <creating-a-site-package>`
51+
52+
Next steps after setting up your first project.
53+
54+
.. card-footer:: :ref:`Creating a site package <creating-a-site-package>`
55+
:button-style: btn btn-secondary stretched-link
56+
5057
.. toctree::
5158
:hidden:
5259
:titlesonly:
@@ -55,3 +62,4 @@ First project setup
5562
SiteManagement/Index
5663
IntroductionPackage/Index
5764
Settings
65+
CreateSitePackage

0 commit comments

Comments
 (0)