Skip to content

Commit 506071f

Browse files
jonirouAtTalanlinawolf
authored andcommitted
Add Sitepackage builder process (#284)
* Update EmptyInstallation.png Update version and project name * Update PageModule.png Update TYPO3 version (not -dev) And foolowing tutorial, recycler extension is installed * Add Sitepackage builder process * Add Sitepackage builder process (cherry picked from commit 8ea51a5)
1 parent 782bc96 commit 506071f

File tree

3 files changed

+27
-34
lines changed

3 files changed

+27
-34
lines changed

Documentation/MinimalExample/Index.rst

Lines changed: 27 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Create a minimal TYPO3 extension manually
4242
}
4343
}
4444
45+
.. _minimal-b13-make-extension:
4546

4647
Create a minimal TYPO3 extension using b13/make
4748
===============================================
@@ -112,7 +113,32 @@ After you have created your site package extension you can uninstall :composer:`
112113
Before your brand new site package extension takes effect in your TYPO3
113114
installation, you have to install it. First you have to edit your composer.json in the root of your installation directory to add `packages` as a local repository.
114115

116+
.. _minimal-site-package-builder:
115117

118+
Create a minimal TYPO3 extension using the Sitepackage Builder
119+
==============================================================
120+
121+
To quickly build a site package you can also use the
122+
`Sitepackage Builder <https://get.typo3.org/sitepackage>`__.
123+
124+
To follow this tutorial you can fill in the form like that :
125+
126+
.. figure:: SitePackageGeneratorForm.png
127+
:alt: Form fields to generate the tutorial package site
128+
:caption: Form fields to generate the tutorial package site
129+
130+
The summary of your data is then displayed.
131+
132+
.. figure:: SitePackageGeneratorSummary.png
133+
:alt: Summary of information provided
134+
:caption: Summary of information provided
135+
136+
You have to click on the "Download" link, on the top of the summary
137+
in order to get your zipped site package.
138+
139+
You can then unzip the zip file, place the resulting folder in your
140+
‘packages’ folder and replace the ‘_’ with a ‘-’ in the folder name.
141+
So `my_site_package` become `my-site-package`.
116142

117143
.. _extension-installation:
118144

@@ -132,39 +158,6 @@ followed these steps:
132158
Install the site package you just created
133159
-----------------------------------------
134160

135-
From all extensions, including our site package extension, must be installed
136-
via Composer.
137-
138-
As a site package is created with site-specific files it is usually best to keep
139-
the files together in a version control system such as Git.
140-
141-
Create a directory for local version-controlled extensions at the
142-
root-level of your installation. The name is arbitrary, we use
143-
:file:`packages/` here.
144-
145-
Then edit your :file:`composer.json` in the root of your installation directory
146-
to add the path as a local repository.
147-
148-
Add the following lines:
149-
150-
.. code-block:: json
151-
:caption: page_root/composer.json
152-
153-
{
154-
"name": "myvendor/mysite",
155-
"repositories": [
156-
{
157-
"type": "path",
158-
"url": "./packages/*"
159-
}
160-
],
161-
"require": {
162-
"typo3/cms-core": "^13.4",
163-
"..." : "..."
164-
},
165-
"..." : "..."
166-
}
167-
168161
Move your extension folder :path:`my-site-package/` into the :path:`packages/`
169162
folder. Then *require* the extension via Composer using the
170163
package name defined in the site package extension's :file:`composer.json` now located
@@ -183,7 +176,7 @@ require it by:
183176
:caption: Execute in directory page_root
184177
185178
composer require myvendor/my-site-package:@dev
186-
179+
187180
.. _extension-installation-project-structure:
188181

189182
Project file structure
82 KB
Loading
283 KB
Loading

0 commit comments

Comments
 (0)