Skip to content

Commit eb8029b

Browse files
committed
update and generate docs
1 parent 58bb21f commit eb8029b

File tree

2 files changed

+28
-18
lines changed

2 files changed

+28
-18
lines changed

docs/recipe/typo3.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The [deploy](#deploy) task of **TYPO3** consists of:
3737
* [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs
3838
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors
3939
* [typo3:cache:warmup](/docs/recipe/typo3.md#typo3-cache-warmup) – TYPO3 - Cache warmup for system caches
40-
* [typo3:database:updateschema](/docs/recipe/typo3.md#typo3-extension-setup) – TYPO3 - Perform schema updates
40+
* [typo3:database:updateschema](/docs/recipe/typo3.md#typo3-database-updateschema) – TYPO3 - Update database schema
4141
* [typo3:extension:setup](/docs/recipe/typo3.md#typo3-extension-setup) – TYPO3 - Set up all extensions
4242
* [typo3:language:update](/docs/recipe/typo3.md#typo3-language-update) – TYPO3 - Update the language files of all activated extensions
4343
* [typo3:cache:flush](/docs/recipe/typo3.md#typo3-cache-flush) – TYPO3 - Clear all caches
@@ -170,7 +170,7 @@ Composer install options for production.
170170

171171

172172
### use_rsync
173-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L118)
173+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L117)
174174

175175
If set in the config this recipe uses rsync.
176176
Default setting: false (uses the Git repository)
@@ -181,7 +181,7 @@ false
181181

182182

183183
### update_code_task
184-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L120)
184+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L119)
185185

186186

187187

@@ -191,7 +191,7 @@ return get('use_rsync') ? 'rsync' : 'deploy:update_code';
191191

192192

193193
### rsync
194-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L148)
194+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L147)
195195

196196

197197

@@ -212,15 +212,15 @@ return get('use_rsync') ? 'rsync' : 'deploy:update_code';
212212

213213

214214
### typo3_updateschema_types
215-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L165)
215+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L164)
216216

217-
List of schema update types
217+
List of schema update types.
218+
`safe` includes all necessary operations, to add or change fields or tables.
218219

219220
```php title="Default value"
220221
'safe'
221222
```
222223

223-
`safe` includes all necessary operations, to add or change fields or tables. See [TYPO3 Reference](https://docs.typo3.org/p/helhum/typo3-console/main/en-us/CommandReference/DatabaseUpdateschema.html) for more information.
224224

225225

226226
## Tasks
@@ -230,8 +230,11 @@ List of schema update types
230230

231231

232232

233+
234+
235+
233236
### typo3\:cache\:flush {#typo3-cache-flush}
234-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L174)
237+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L173)
235238

236239
TYPO3 - Clear all caches.
237240

@@ -240,31 +243,39 @@ All run via [bin/php](/docs/recipe/common.md#bin/php) [release_path](/docs/recip
240243

241244

242245
### typo3\:cache\:warmup {#typo3-cache-warmup}
243-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L179)
246+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L178)
244247

245248
TYPO3 - Cache warmup for system caches.
246249

247250

251+
252+
248253
### typo3\:language\:update {#typo3-language-update}
249-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L184)
254+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L183)
250255

251256
TYPO3 - Update the language files of all activated extensions.
252257

253258

259+
260+
254261
### typo3\:extension\:setup {#typo3-extension-setup}
255-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L189)
262+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L188)
256263

257264
TYPO3 - Set up all extensions.
258265

259266

260-
### typo3\:extension\:setup {#typo3-database-updateschema}
261-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L194)
262267

263-
TYPO3 - Perform schema updates.
268+
269+
### typo3\:database\:updateschema {#typo3-database-updateschema}
270+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L193)
271+
272+
TYPO3 - Update database schema.
273+
274+
264275

265276

266277
### deploy {#deploy}
267-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L215)
278+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L214)
268279

269280
Deploys a TYPO3 project.
270281

recipe/typo3.php

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,8 @@
158158
]);
159159

160160
/**
161-
* List of schema update types
162-
* default: safe (includes all necessary operations, to add or change fields or tables)
163-
* https://docs.typo3.org/p/helhum/typo3-console/main/en-us/CommandReference/DatabaseUpdateschema.html
161+
* List of schema update types.
162+
* `safe` includes all necessary operations, to add or change fields or tables.
164163
*/
165164
set('typo3_updateschema_types', 'safe');
166165

0 commit comments

Comments
 (0)