Skip to content

Commit ef897a1

Browse files
[TASK] Overhaul extension development kickstarter make (#6231)
Releases: main, 13.4
1 parent ad5105c commit ef897a1

File tree

1 file changed

+28
-27
lines changed
  • Documentation/ExtensionArchitecture/Kickstarter/Make

1 file changed

+28
-27
lines changed

Documentation/ExtensionArchitecture/Kickstarter/Make/Index.rst

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ Make
1212
Kickstart a TYPO3 Extension with "Make"
1313
=======================================
1414

15-
"`Make <https://github.com/b13/make>`__" is a TYPO3 extension provided by b13. It features a quick way to create
16-
a basic extension scaffold on the console. The extension is available for TYPO3 v10 and above.
15+
"`Make <https://github.com/b13/make>`__" is a TYPO3 extension provided by b13. It is a quick way to create
16+
a basic extension scaffold via the console. The extension is available for TYPO3 v10 and above.
1717

1818
1. Install "Make"
1919
=================
2020

2121
In Composer-based TYPO3 installations you can install the
22-
extension via Composer, you should install it as :bash:`dev` dependency as
22+
extension via Composer, but you should install it as a :bash:`dev` dependency as
2323
it should not be used on production systems:
2424

2525
.. tabs::
@@ -71,57 +71,57 @@ Call the CLI script on the console:
7171
3. Answer the prompt
7272
=====================
7373

74-
"Make" will now answer some questions that we describe here in-depth:
74+
"Make" will now ask you the following questions:
7575

7676
`Enter the composer package name (e.g. "vendor/awesome"):`
77-
A valid composer package name is defined in the
77+
Valid composer package names are defined in the
7878
`getcomposer name scheme <https://getcomposer.org/doc/04-schema.md#name>`__.
7979

80-
The vendor **should** be a unique name that is not yet used by other
80+
The vendor **should** be a unique name that is not used by any other
8181
companies or developers.
8282

8383
Example: `my-vendor/my-test`
8484

8585
`Enter the extension key [my_test]:`
86-
The extension key **should** follow the rules for best practises on
86+
The extension key **should** follow the rules for best practice for
8787
:ref:`choosing an extension key <extension-key>` if you plan to publish
88-
your extension. In most cases, the default, here `my_test`, is sufficient.
88+
your extension. In most cases the default, here `my_test`, will be sufficient.
8989
Press :kbd:`enter` to accept the default or enter another name.
9090

9191
`Enter the PSR-4 namespace [T3docs/MyTest]:`
9292
The namespace has to be unique within the project. Usually the default
93-
should be unique, as your vendor is unique, and you can accept it by
93+
will be unique because your vendor name is unique, and you can accept it by
9494
pressing :kbd:`enter`.
9595

9696
`Choose supported TYPO3 versions (comma separate for multiple) [TYPO3 v11 LTS]:`
97-
If you want to support both TYPO3 v11 and v12, enter the following:
97+
If you want your extension to be compatible with both TYPO3 v11 and v12, enter:
9898
`11,12`
9999

100100
`Enter a description of the extension:`
101-
A description is mandatory. You can change it later in the file
102-
:file:`composer.json <extension-composer-json>` of the extension.
101+
A description is mandatory. You can change it later in the
102+
:file:`composer.json <extension-composer-json>` extension file.
103103

104104
`Where should the extension be created? [src/extensions/]:`
105-
If you have a special path for installing local extensions like
105+
If you have a specific folder for your local extensions like
106106
:file:`packages` enter it here. Otherwise you can accept the
107107
default.
108108

109109
`May we add a basic service configuration for you? (yes/no) [yes]:`
110110
If you choose `yes` "Make" will create a basic
111-
:file:`Configuration/Services.yaml` to configure :ref:`dependency injection <DependencyInjection>`.
111+
:file:`Configuration/Services.yaml` which configures :ref:`dependency injection <DependencyInjection>`.
112112

113113
`May we create a ext_emconf.php for you? (yes/no) [no]:`
114114
Mandatory for extensions supporting TYPO3 v10. Starting with v11:
115-
If your extension should be installable in legacy TYPO3 installations
116-
choose `yes`. This is not necessary for local extensions in Composer-based
117-
installations.
115+
If your extension needs be installable in legacy TYPO3 installations
116+
choose `yes`. If your extension is local and in a Composer-based
117+
installation it is not necessary and you can choose `no`.
118118

119119
4. Have a look at the result
120120
=============================
121121

122-
"Make" created a subfolder under :file:`src/extensions` with the
123-
composer name (without vendor) of your extension. By default, it contains
124-
the following files:
122+
"Make" has now created a subfolder under :file:`src/extensions` with the
123+
same name as the composer name (without vendor) of your extension. By default
124+
the subfolder contains the following files:
125125

126126
.. code-block:: none
127127
:caption: Page tree of directory :file:`src/extensions`
@@ -137,11 +137,12 @@ the following files:
137137
5. Install the extension
138138
========================
139139

140-
On Composer-based installations the extension is not installed yet.
141-
It will not be displayed in the :guilabel:`Extension Manager` in the backend.
140+
On Composer-based installations the extension will be created but not installed.
141+
Therefore it won't be displayed in the backend :guilabel:`Extension Manager`.
142142

143-
To install it, open the main :file:`composer.json <extension-composer-json>` of your **project** (not the
144-
one in the created extension) and add the extension directory as new repository:
143+
To install it, open the main :file:`composer.json <extension-composer-json>` of
144+
your **project** (not the one in the new extension) and define the extension
145+
directory as a new repository under `repositories`:
145146

146147
.. code-block:: json
147148
:caption: my_project_root/composer.json
@@ -158,8 +159,8 @@ one in the created extension) and add the extension directory as new repository:
158159
"...": "..."
159160
}
160161
161-
Then require the extension on Composer-based systems, using the composer
162-
name defined in the prompt of the script:
162+
Then, on Composer-based systems, require the extension using the composer
163+
name:
163164

164165
.. tabs::
165166

@@ -182,7 +183,7 @@ name defined in the prompt of the script:
182183
6. Add functionality
183184
=====================
184185

185-
The following additional commands are available to add more functionality
186+
The following commands are also available if you want to add more functionality
186187
to your extension:
187188

188189
* `make:backendcontroller` - :ref:`Create a new backend controller <extension-make-backend-controller>`

0 commit comments

Comments
 (0)