Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add hint for the plugin name #1651

Merged
merged 3 commits into from
Jan 15, 2025
Merged

Add hint for the plugin name #1651

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fc1fdd0
docs: Add hint for the plugin name
TrayserCassa Jan 15, 2025
0332038
Add Code example to be more clear and fix comma
Isengo1989 Jan 15, 2025
a3af311
Merge branch 'main' into update-remove-plugin-hint
TrayserCassa Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions guides/hosting/installation-updates/deployments/deployment-helper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

The Deployment Helper is a tool that unifies the steps executed after the Code has been uploaded to the server.
On a traditional deployment, you would run it after the files have been uploaded.
When using a Containerized environment you would run Deployment Helper with the new source code and then switch over the traffic.
When using a Containerized environment, you would run Deployment Helper with the new source code and then switch over the traffic.

## Installing the Deployment Helper

Expand Down Expand Up @@ -137,7 +137,22 @@

## Removal of extensions

If you want to remove an extension you need to do it in two steps:
To find the name (for example `SwagPlatformDemoData`) of the extension you want to remove, use the `./bin/console plugin:list` command.

```shell
./bin/console plugin:list

Shopware Plugin Service
=======================

----------------------------- ------------------------------------------ ---------------------------------------------- --------- ----------------- ------------------- ----------- -------- ------------- ----------------------
Plugin Label Composer name Version Upgrade version Author Installed Active Upgradeable Required by composer
----------------------------- ------------------------------------------ ---------------------------------------------- --------- ----------------- ------------------- ----------- -------- ------------- ----------------------
SwagPlatformDemoData Shopware 6 Demo data swag/demo-data 2.0.1 shopware AG Yes No No No

Check warning on line 151 in guides/hosting/installation-updates/deployments/deployment-helper.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] guides/hosting/installation-updates/deployments/deployment-helper.md#L151 

Consider adding a comma between these interjections. (OK_OK_COMMA[1])
Suggestions: `No, No`, `No`
Rule: https://community.languagetool.org/rule/show/OK_OK_COMMA?lang=en-US&subId=1
Category: PUNCTUATION
Raw output 
guides/hosting/installation-updates/deployments/deployment-helper.md:151:182: Consider adding a comma between these interjections. (OK_OK_COMMA[1])
 Suggestions: `No, No`, `No`
 Rule: https://community.languagetool.org/rule/show/OK_OK_COMMA?lang=en-US&subId=1
 Category: PUNCTUATION
----------------------------- ------------------------------------------ ---------------------------------------------- --------- ----------------- ------------------- ----------- -------- ------------- ----------------------
```

If you want to remove an extension, you need to do it in two steps:

1.) Set the extension to `remove` in the `.shopware-project.yml` file

Expand Down Expand Up @@ -168,7 +183,7 @@
In a Docker environment, you have a base image with a running PHP Webserver.
From that image you make a new image with your Shopware source code.
To prepare the Shopware source code, you can run [shopware-cli project ci](https://sw-cli.fos.gg) to install the dependencies and build the assets.
On deployment you spawn a second container or init a container, which runs the Deployment Helper.
On deployment, you spawn a second container or init a container, which runs the Deployment Helper.
The Deployment Helper sets up Shopware when it is not installed, installs the extensions and runs the one-time tasks.

### SFTP / Deployer
Expand Down
Loading