From 9cd6b54ce6a5fcb11eeb10e5637affb05e344803 Mon Sep 17 00:00:00 2001
From: Akos <akos@glue.be>
Date: Mon, 22 Apr 2024 14:08:17 +0200
Subject: [PATCH] run docgen

---
 docs/recipe/magento2.md | 72 ++++++++++++++++++++---------------------
 1 file changed, 36 insertions(+), 36 deletions(-)

diff --git a/docs/recipe/magento2.md b/docs/recipe/magento2.md
index c2df29732..836aca55b 100644
--- a/docs/recipe/magento2.md
+++ b/docs/recipe/magento2.md
@@ -33,7 +33,7 @@ The [deploy](#deploy) task of **Magento 2** consists of:
   * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy
   * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy
   * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release
-  * [deploy:update_code](/docs/recipe/shopware.md#deployupdate_code) – 
+  * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code
   * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs
   * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs
 * [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors
@@ -353,7 +353,7 @@ true
 
 
 ### artifact_file
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L344)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L345)
 
 The file the artifact is saved to
 
@@ -363,7 +363,7 @@ The file the artifact is saved to
 
 
 ### artifact_dir
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L347)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L348)
 
 The directory the artifact is saved in
 
@@ -373,7 +373,7 @@ The directory the artifact is saved in
 
 
 ### artifact_excludes_file
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L351)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L352)
 
 Points to a file with a list of files to exclude from packaging.
 The format is as with the `tar --exclude-from=[file]` option
@@ -384,7 +384,7 @@ The format is as with the `tar --exclude-from=[file]` option
 
 
 ### build_from_repo
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L354)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L355)
 
 If set to true, the artifact is built from a clean copy of the project repository instead of the current working directory
 
@@ -394,7 +394,7 @@ false
 
 
 ### repository
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L357)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L358)
 
 Overrides [repository](/docs/recipe/common.md#repository) from `recipe/common.php`.
 
@@ -406,7 +406,7 @@ null
 
 
 ### artifact_path
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L360)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L361)
 
 The relative path to the artifact file. If the directory does not exist, it will be created
 
@@ -419,7 +419,7 @@ return get('artifact_dir') . '/' . get('artifact_file');
 
 
 ### bin/tar
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L368)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L369)
 
 The location of the tar command. On MacOS you should have installed gtar, as it supports the required settings
 :::info Autogenerated
@@ -430,14 +430,14 @@ The value of this configuration is autogenerated on access.
 
 
 ### additional_shared_files
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L440)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L441)
 
 Array of shared files that will be added to the default shared_files without overriding
 
 
 
 ### additional_shared_dirs
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L442)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L443)
 
 Array of shared directories that will be added to the default shared_dirs without overriding
 
@@ -486,7 +486,7 @@ in `app/etc/config.php`, e.g.:
 
 
 ### magento:deploy:assets:adminhtml
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L209)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L210)
 
 Deploys assets for backend only.
 
@@ -494,7 +494,7 @@ Deploys assets for backend only.
 
 
 ### magento:deploy:assets:frontend
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L214)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L215)
 
 Deploys assets for frontend only.
 
@@ -502,7 +502,7 @@ Deploys assets for frontend only.
 
 
 ### magento:sync:content_version
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L262)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L263)
 
 Syncs content version.
 
@@ -510,7 +510,7 @@ Syncs content version.
 
 
 ### magento:maintenance:enable
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L272)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L273)
 
 Enables maintenance mode.
 
@@ -518,7 +518,7 @@ Enables maintenance mode.
 
 
 ### magento:maintenance:disable
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L278)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L279)
 
 Disables maintenance mode.
 
@@ -526,7 +526,7 @@ Disables maintenance mode.
 
 
 ### magento:maintenance:enable-if-needed
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L284)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L285)
 
 Set maintenance mode if needed.
 
@@ -534,7 +534,7 @@ Set maintenance mode if needed.
 
 
 ### magento:config:import
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L291)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L292)
 
 Config Import.
 
@@ -542,7 +542,7 @@ Config Import.
 
 
 ### magento:upgrade:db
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L300)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L301)
 
 Upgrades magento database.
 
@@ -550,7 +550,7 @@ Upgrades magento database.
 
 
 ### magento:cache:flush
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L310)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L311)
 
 Flushes Magento Cache.
 
@@ -558,7 +558,7 @@ Flushes Magento Cache.
 
 
 ### deploy:magento
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L315)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L316)
 
 Magento2 deployment operations.
 
@@ -575,7 +575,7 @@ This task is group task which contains next tasks:
 
 
 ### magento:build
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L325)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L326)
 
 Magento2 build operations.
 
@@ -588,7 +588,7 @@ This task is group task which contains next tasks:
 
 
 ### deploy
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L331)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L332)
 
 Deploys your project.
 
@@ -604,7 +604,7 @@ This task is group task which contains next tasks:
 
 
 ### artifact:package
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L379)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L380)
 
 Packages all relevant files in an artifact.
 
@@ -612,7 +612,7 @@ Packages all relevant files in an artifact.
 
 
 ### artifact:upload
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L389)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L390)
 
 Uploads artifact in release folder for extraction.
 
@@ -620,7 +620,7 @@ Uploads artifact in release folder for extraction.
 
 
 ### artifact:extract
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L394)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L395)
 
 Extracts artifact in release path.
 
@@ -628,7 +628,7 @@ Extracts artifact in release path.
 
 
 ### build:remove-generated
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L400)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L401)
 
 Clears generated files prior to building.
 
@@ -636,7 +636,7 @@ Clears generated files prior to building.
 
 
 ### build:prepare
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L405)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L406)
 
 Prepare local artifact build.
 
@@ -644,7 +644,7 @@ Prepare local artifact build.
 
 
 ### artifact:build
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L430)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L431)
 
 Builds an artifact.
 
@@ -661,7 +661,7 @@ This task is group task which contains next tasks:
 
 
 ### deploy:additional-shared
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L446)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L447)
 
 Adds additional files and dirs to the list of shared files and dirs.
 
@@ -669,7 +669,7 @@ Adds additional files and dirs to the list of shared files and dirs.
 
 
 ### magento:set_cache_prefix
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L461)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L462)
 
 Update cache id_prefix.
 
@@ -683,7 +683,7 @@ after('deploy:magento', 'magento:cleanup_cache_prefix');
 
 
 ### magento:cleanup_cache_prefix
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L501)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L502)
 
 Cleanup cache id_prefix env files.
 
@@ -691,7 +691,7 @@ After successful deployment, move the tmp_env.php file to env.php ready for next
 
 
 ### magento:cron:stop
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L517)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L518)
 
 Remove cron from crontab and kill running cron jobs.
 
@@ -703,7 +703,7 @@ To use this feature, add the following to your deployer scripts:
 
 
 ### magento:cron:install
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L533)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L534)
 
 Install cron in crontab.
 
@@ -715,7 +715,7 @@ To use this feature, add the following to your deployer scripts:
 
 
 ### artifact:prepare
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L539)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L540)
 
 Prepares an artifact on the target server.
 
@@ -735,7 +735,7 @@ This task is group task which contains next tasks:
 
 
 ### artifact:finish
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L552)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L553)
 
 Executes the tasks after artifact is released.
 
@@ -750,7 +750,7 @@ This task is group task which contains next tasks:
 
 
 ### artifact:deploy
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L561)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L562)
 
 Actually releases the artifact deployment.