Skip to content

Commit 4bc695c

Browse files
github-actions[bot]github-actions[bot]
committed
[automatic] Update docs with bin/docgen
1 parent 70df6ff commit 4bc695c

File tree

1 file changed

+27
-48
lines changed

1 file changed

+27
-48
lines changed

‎docs/recipe/typo3.md

Lines changed: 27 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,7 @@ The [deploy](#deploy) task of **TYPO3** consists of:
3939
* [typo3:cache:warmup](/docs/recipe/typo3.md#typo3-cache-warmup) – TYPO3 - Cache warmup for system caches
4040
* [typo3:extension:setup](/docs/recipe/typo3.md#typo3-extension-setup) – TYPO3 - Set up all extensions
4141
* [typo3:language:update](/docs/recipe/typo3.md#typo3-language-update) – TYPO3 - Update the language files of all activated extensions
42-
* [typo3:cache:flush](/docs/recipe/typo3.md#typo3-cache-flush) – TYPO3 - Cache clearing for frontend caches
43-
* [typo3:cache:pages:warmup](/docs/recipe/typo3.md#typo3-cache-pages-warmup) – TYPO3 - Cache warmup for frontend caches
42+
* [typo3:cache:flush](/docs/recipe/typo3.md#typo3-cache-flush) – TYPO3 - Clear all caches
4443
* [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy
4544
* [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases
4645
* [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project
@@ -59,7 +58,7 @@ return json_decode(file_get_contents('./composer.json'), true, 512, JSON_THROW_O
5958
```
6059

6160

62-
### typo3_webroot
61+
### typo3/public_dir
6362
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L17)
6463

6564
DocumentRoot / WebRoot for the TYPO3 installation
@@ -100,49 +99,38 @@ Shared directories
10099

101100
```php title="Default value"
102101
[
103-
'{{typo3_webroot}}/fileadmin',
104-
'{{typo3_webroot}}/typo3temp',
105-
'var/session',
106-
'var/log',
102+
'{{typo3/public_dir}}/fileadmin',
103+
'{{typo3/public_dir}}/assets',
104+
'{{typo3/public_dir}}/typo3temp/assets',
107105
'var/lock',
108-
'var/charset',
109-
]
110-
```
111-
112-
113-
### shared_files
114-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L60)
115-
116-
Overrides [shared_files](/docs/recipe/deploy/shared.md#shared_files) from `recipe/deploy/shared.php`.
117-
118-
Shared files
119-
120-
```php title="Default value"
121-
[
122-
'config/system/settings.php',
123-
'.env',
106+
'var/log',
107+
'var/session',
108+
'var/spool',
124109
]
125110
```
126111

127112

128113
### writable_dirs
129-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L68)
114+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L70)
130115

131116
Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`.
132117

133118
Writeable directories
134119

135120
```php title="Default value"
136121
[
137-
'{{typo3_webroot}}/fileadmin',
138-
'{{typo3_webroot}}/typo3temp',
139-
'var',
122+
'{{typo3/public_dir}}/fileadmin',
123+
'{{typo3/public_dir}}/assets',
124+
'{{typo3/public_dir}}/typo3temp/assets',
125+
'var/cache',
126+
'var/lock',
127+
'var/log',
140128
]
141129
```
142130

143131

144132
### composer_options
145-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L77)
133+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L82)
146134

147135
Overrides [composer_options](/docs/recipe/deploy/vendors.md#composer_options) from `recipe/deploy/vendors.php`.
148136

@@ -154,7 +142,7 @@ Composer options
154142

155143

156144
### use_rsync
157-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L83)
145+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L88)
158146

159147
If set in the config this recipe uses rsync. Default: false (use the Git repository)
160148

@@ -164,7 +152,7 @@ false
164152

165153

166154
### update_code_task
167-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L85)
155+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L90)
168156

169157

170158

@@ -174,7 +162,7 @@ return get('use_rsync') ? 'rsync' : 'deploy:update_code';
174162

175163

176164
### rsync
177-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L112)
165+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L118)
178166

179167

180168

@@ -198,55 +186,47 @@ return get('use_rsync') ? 'rsync' : 'deploy:update_code';
198186
## Tasks
199187

200188
### typo3\:update_code {#typo3-update_code}
201-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L89)
202-
203-
204-
189+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L94)
205190

206191

207192

208-
### typo3\:cache\:warmup {#typo3-cache-warmup}
209-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L126)
210-
211-
TYPO3 - Cache warmup for system caches.
212-
213193

214194

215195

216196
### typo3\:cache\:flush {#typo3-cache-flush}
217-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L132)
197+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L133)
218198

219-
TYPO3 - Cache clearing for frontend caches.
199+
TYPO3 - Clear all caches.
220200

221201

222202

223203

224-
### typo3\:cache\:pages\:warmup {#typo3-cache-pages-warmup}
204+
### typo3\:cache\:warmup {#typo3-cache-warmup}
225205
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L138)
226206

227-
TYPO3 - Cache warmup for frontend caches.
207+
TYPO3 - Cache warmup for system caches.
228208

229209

230210

231211

232212
### typo3\:language\:update {#typo3-language-update}
233-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L144)
213+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L143)
234214

235215
TYPO3 - Update the language files of all activated extensions.
236216

237217

238218

239219

240220
### typo3\:extension\:setup {#typo3-extension-setup}
241-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L150)
221+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L148)
242222

243223
TYPO3 - Set up all extensions.
244224

245225

246226

247227

248228
### deploy {#deploy}
249-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L159)
229+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L156)
250230

251231
Deploys a TYPO3 project.
252232

@@ -266,7 +246,6 @@ This task is group task which contains next tasks:
266246
* [typo3:extension:setup](/docs/recipe/typo3.md#typo3-extension-setup)
267247
* [typo3:language:update](/docs/recipe/typo3.md#typo3-language-update)
268248
* [typo3:cache:flush](/docs/recipe/typo3.md#typo3-cache-flush)
269-
* [typo3:cache:pages:warmup](/docs/recipe/typo3.md#typo3-cache-pages-warmup)
270249
* [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock)
271250
* [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup)
272251
* [deploy:success](/docs/recipe/common.md#deploy-success)

0 commit comments

Comments
 (0)