Skip to content

Commit 678e1d4

Browse files
[TASK] Overhaul extension development site package introduction (#6259)
Releases: main, 13.4 Co-authored-by: Sarah McCarthy <sarahmccarthy123@yahoo.com>
1 parent 3477367 commit 678e1d4

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

Documentation/ExtensionArchitecture/SitePackage/Introduction.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ Introduction into using site packages
1212
Site package benefits
1313
=====================
1414

15-
Developing a website can be approached in different ways. Standard
16-
websites usually consist of HTML documents which contain text and reference
15+
Developing a website can be approached in different ways. A typical
16+
website consists of HTML documents containing text and references to
1717
image files, video files, styles, etc. Because it is an enterprise content
18-
management system, TYPO3 features a clean separation between design, content and
19-
functionality and allows developers/integrators to add simple or
20-
sophisticated functionality easily.
18+
management system, TYPO3 has a clean separation between design, content and
19+
functionality and allows developers/integrators to easily add simple or
20+
sophisticated functionality.
2121

2222
.. _site-package-encapsulation:
2323

@@ -26,37 +26,37 @@ Encapsulation
2626

2727
Using extensions is a powerful way to get the most out of TYPO3. Extensions
2828
can be installed, uninstalled and replaced. They can extend the core TYPO3
29-
system with further functions and features. An extension typically
29+
system with new functions and features. An extension typically
3030
consists of PHP files, and can also contain design templates (HTML,
3131
CSS, JavaScript files, etc.) and global configuration settings. The visual
3232
appearance of a website does not necessarily require any PHP code. However, the
3333
site package extension described in this tutorial contains exactly two PHP files
3434
(plus a handful of HTML/CSS and configuration files) and is an *extension* to
35-
TYPO3. The PHP code can be copied from this tutorial if the reader does not
35+
TYPO3. You can simply copy the PHP code in this tutorial if you do not
3636
have any programming knowledge.
3737

3838
.. _site-package-version-controll:
3939

4040
Version control
4141
---------------
4242

43-
In building the site package as an extension, all relevant files are stored in
44-
one place and changes can easily be tracked in a version control system
43+
The advantage of a site package extension is that all files relevant to the website
44+
are stored in one place and can easily be tracked in a version control system
4545
such as Git. The site package approach is not the only way of creating TYPO3
46-
websites but it is flexible and professional and not overly complicated.
46+
websites but it is convenient and professional and not overly-complicated.
4747

4848
.. _site-package-di:
4949

5050
Dependency management
5151
---------------------
5252

53-
TYPO3 extensions allow dependencies to other extensions and/or the TYPO3 version
54-
to be defined. This is called "Dependency Management" and makes deployment easy
55-
and fail-safe. Most TYPO3 sites are dependent on a number of extensions. Some
56-
examples are "News" or "Powermail". A site package extension which contains
53+
TYPO3 extensions can have specific dependencies set to other extensions and TYPO3
54+
versions. This is called "Dependency Management" and makes deployment easy
55+
and fail-safe. Most TYPO3 sites are dependent on extensions such as
56+
"News" and "Powermail". A site package extension which contains
5757
global configuration settings for these extensions will define the dependencies
5858
for you. When the site package extension is installed in an
59-
empty TYPO3 instance, all dependent extensions are automatically downloaded from
59+
empty TYPO3 instance, the dependent extensions are automatically downloaded from
6060
the `TYPO3 Extension Repository <https://extensions.typo3.org>`__ and installed.
6161

6262
.. _site-package-separation:
@@ -78,7 +78,7 @@ still not be stored in the userspace.
7878
Security
7979
--------
8080

81-
Files in :file:`fileadmin/` are typically meant to be publicly accessible by
81+
Files in :file:`fileadmin/` are meant to be publicly accessible by
8282
convention. To avoid disclosing sensitive system information (see the
8383
:ref:`TYPO3 Security Guide <t3coreapi:security>` for further details),
8484
configuration files should not be stored in :file:`fileadmin/`.
@@ -89,10 +89,10 @@ Deployment
8989
----------
9090

9191
TYPO3 follows the *convention over configuration*
92-
paradigm. If files and directories in the site-package
92+
paradigm. If files and directories in the site package
9393
extension use the naming convention, they are loaded automatically as
9494
soon as the extension is installed/activated. This means the
95-
extension can be easily deployed using Composer.
95+
extension can easily be deployed with Composer.
9696
Deployment can be automated by system administrators.
9797

9898
.. _site-package-distributable:

0 commit comments

Comments
 (0)