diff --git a/products/cli/extension-commands/admin-watcher.md b/products/cli/extension-commands/admin-watcher.md index 8ddd60232..20c3a8414 100644 --- a/products/cli/extension-commands/admin-watcher.md +++ b/products/cli/extension-commands/admin-watcher.md @@ -11,9 +11,9 @@ nav: `shopware-cli extension admin-watch` can be different to the regular Admin Watcher. You can start the regular Admin Watcher with `shopware-cli project admin-watch` ::: -Shopware-CLI has an integrated Standalone Admin Watcher. This is useful if the regular Admin Watcher struggles with the amount of installed extensions and you only want to watch one single extension. The Standalone Watcher works by using the regular build Administration and injects only the changed files of the extension. +Shopware-CLI has an integrated Standalone Admin Watcher. This is useful if the regular Admin Watcher struggles with the number of installed extensions, and you only want to watch one single extension. The Standalone Watcher works by using the regular build Administration and injects only the changed files of the extension. -Therefore the Watcher starts in few milliseconds and is very fast. Additionally, it can be targeted to an external Shopware 6 Instance to debug JavaScript or CSS changes with the external data. +Therefore, the Watcher starts in few milliseconds and is very fast. Additionally, it can be targeted to an external Shopware 6 Instance to debug JavaScript or CSS changes with the external data. ## Starting the Standalone Admin Watcher diff --git a/products/cli/extension-commands/build.md b/products/cli/extension-commands/build.md index 71f52dac1..e7ef28d49 100644 --- a/products/cli/extension-commands/build.md +++ b/products/cli/extension-commands/build.md @@ -7,7 +7,7 @@ nav: # Building extensions and creating archives -Extensions consists of PHP Changes, JavaScript and CSS. To release an extension to the Shopware Store or upload it to a Shopware 6 instance without having to rebuild Storefront and Administration your extension needs to provide the compiled assets. +Extensions consist of PHP Changes, JavaScript and CSS. To release an extension to the Shopware Store or upload it to a Shopware 6 instance without having to rebuild Storefront and Administration, your extension needs to provide the compiled assets. ## Building an extension @@ -37,7 +37,7 @@ build: extraBundles: # Assumes the bundle name is the same as the directory name - path: src/Foo - # Explictly specify the bundle name + # Explicitly specify the bundle name - path: src/Foo name: Foo ``` @@ -48,7 +48,7 @@ build: Building with esbuild works completely standalone without the Shopware codebase. This means if you import files from Shopware, you have to copy it to your extension. ::: -Esbuild can be utilized for JavaScript bundling, offering a significantly faster alternative to the standard Shopware bundling process, as it eliminates the need to involve Shopware for asset building. +Esbuild can be used for JavaScript bundling, offering a significantly faster alternative to the standard Shopware bundling process, as it eliminates the need to involve Shopware for asset building. ```yaml # .shopware-extension.yml @@ -71,7 +71,7 @@ shopware-cli extension zip The command copies the extension to a temporary directory, builds the assets, deletes unnecessary files and creates a zip archive of the extension. The archive is placed in the current working directory. -**By default the command picks the latest released git tag**, use `--disable-git` as flag to disable this behavior and use the current source code. Besides disabling it completely, you can also specify a specific tag or commit using `--git-commit`. +**By default, the command picks the latest released git tag**, use the `--disable-git` flag to disable this behavior and use the current source code. Besides disabling it completely, you can also specify a specific tag or commit using `--git-commit`. ### Bundling composer dependencies @@ -129,14 +129,14 @@ changelog: enabled: true ``` -It utilizes the commits between the last tag and the current commit to generate the changelog. Additionally, it can be configured to filter commits and build the changelog differently. +It generates the changelog by utilizing the commits between the last tag and the current commit. Additionally, it can be configured to filter commits and build the changelog differently. ```yaml changelog: enabled: true # only the commits matching to this regex will be used pattern: '^NEXT-\d+' - # variables allows to extract metadata out of the commit message + # variables allow extracting metadata out of the commit message variables: ticket: '^(NEXT-\d+)\s' # go template for the changelog, it loops over all commits @@ -145,7 +145,7 @@ changelog: {{end}} ``` -This example checks that all commits in the changelog needs to start with `NEXT-` in the beginning. The `variables` section allows to extract metadata out of the commit message. The `template` is a go template which loops over all commits and generates the changelog. +This example checks that all commits in the changelog needs to start with `NEXT-` in the beginning. The `variables` section allows extracting metadata out of the commit message. The `template` is a go template which loops over all commits and generates the changelog. With the combination of `pattern`, `variables` and `template` we link the commit message to the Shopware ticket system. ### Overwrites diff --git a/products/cli/extension-commands/validation.md b/products/cli/extension-commands/validation.md index 1e882b99f..e6da2768f 100644 --- a/products/cli/extension-commands/validation.md +++ b/products/cli/extension-commands/validation.md @@ -17,7 +17,7 @@ To validate an extension, you can use the following command: shopware-cli extension validate ``` -The path can be absolute or relative to the directory containing the extension or the zip file. The command exists with a non-zero exit code if the validation fails with a error level message. +The path can be absolute or relative to the directory containing the extension or the zip file. The command exists with a non-zero exit code if the validation fails with an error level message. ## What is validated? @@ -32,7 +32,7 @@ The path can be absolute or relative to the directory containing the extension o ## Supported PHP versions for linting -Following PHP versions are supported for linting: +The following PHP versions are supported for linting: - 7.3 - 7.4 diff --git a/products/cli/index.md b/products/cli/index.md index ca7914265..59c267f57 100644 --- a/products/cli/index.md +++ b/products/cli/index.md @@ -7,9 +7,9 @@ nav: # Shopware-CLI -Shopware-CLI is an open-source external command-line interface for Shopware 6. It provides a set of commands to interact with your Shopware instance, build extensions, dump databases and more. The CLI **is a external tool** and needs to be set up separately from your Shopware instance. +Shopware-CLI is an open-source external command-line interface for Shopware 6. It provides a set of commands to interact with your Shopware instance, build extensions, dump databases, and more. The CLI **is an extra tool** and needs to be set up separately from your Shopware instance. -The CLI consists of three main components: +The CLI consists of three command scopes: - Project commands: Commands to interact with your Shopware project - Extension commands: Commands to build Shopware extensions diff --git a/products/cli/installation.md b/products/cli/installation.md index befa396ea..8b73ebc10 100644 --- a/products/cli/installation.md +++ b/products/cli/installation.md @@ -7,7 +7,7 @@ nav: # Installation -You can install the pre-compiled binary (in several different ways), use Docker or compile from the source. +You can install the pre-compiled binary (in several different ways), use Docker or compile it from the source. Below you can find the steps for each of them. @@ -47,7 +47,13 @@ yay -S shopware-cli-bin ### Manually: deb,rpm apt packages -Download the `.deb`, `.rpm` or `.apk` packages from the [releases](https://github.com/FriendsOfShopware/shopware-cli/releases/) page and install them with the appropriate tools. +Download the `.deb`, `.rpm` or `.apk` packages from the [releases](https://github.com/shopware/shopware-cli/releases/) page and install them with the appropriate tools. + +```shell +sudo dpkg -i shopware-cli_0.5.2_linux_amd64.deb # for .deb +sudo rpm -i shopware-cli_0.5.2_linux_arm64.rpm # for .rpm +sudo apk add shopware-cli-0.5.2.apk # for .apk +``` ### Nix @@ -138,9 +144,9 @@ Add the following line to your docker image to copy the binary into your image. COPY --from=shopware/shopware-cli:bin /shopware-cli /usr/local/bin/shopware-cli ``` -## Manually +## Add binary manually -Download the pre-compiled binaries from the [releases](https://github.com/FriendsOfShopware/shopware-cli/releases/) page and copy them to the desired location. +Download the pre-compiled binaries from the [releases](https://github.com/shopware/shopware-cli/releases) page and copy them to the desired location. ## Running with Docker diff --git a/products/cli/project-commands/build.md b/products/cli/project-commands/build.md index 89e664ef8..6af2d75a4 100644 --- a/products/cli/project-commands/build.md +++ b/products/cli/project-commands/build.md @@ -17,9 +17,9 @@ This command modifies the given directory and deletes files. Make sure you have shopware-cli project ci ``` -## What it does? +## What does it do? -- It runs `composer install` (by default only installs the production dependencies, use `--with-dev-dependencies` to install the dev dependencies as well) +- It runs `composer install` (by default, only installs the production dependencies, use `--with-dev-dependencies` to install the dev dependencies as well) - Looks for missing assets of extensions and only compiles the missing assets to speed up the build process - Deletes unnecessary files like `node_modules` and many more to save disk space - Deletes source code of compiled assets to save disk space @@ -53,12 +53,12 @@ You can configure the build process with a `.shopware-project.yml` file. The fol build: # Browserlist configuration for Storefront browserslist: 'defaults' - # Which paths should be deleted + # Paths that should be deleted cleanup_paths: - 'node_modules' # At the end of the process, bin/console asset:install is executed, this can be disabled here disable_asset_copy: false - # Exclude following extensions from the build process + # Exclude the following extensions from the build process exclude_extensions: - 'SwagExample' # Keep the extension Administration and Storefront source code diff --git a/products/cli/project-commands/helper-commands.md b/products/cli/project-commands/helper-commands.md index fb68c028d..0af04e64d 100644 --- a/products/cli/project-commands/helper-commands.md +++ b/products/cli/project-commands/helper-commands.md @@ -17,7 +17,7 @@ To create a new project, you can use the following command: shopware-cli project create ``` -It will ask you for the Shopware version. You can pass also the version as second parameter: +It will ask you for the Shopware version. You can pass the version as second parameter: ```bash shopware-cli project create @@ -36,7 +36,7 @@ Shopware-CLI contains replacements for `bin/build-administration.sh` and `bin/bu | bin/watch-storefront.sh | `shopware-cli project storefront-watch` | | bin/watch-administration.sh | `shopware-cli project admin-watch` | -Additionally to the replacement, Shopware-CLI allows to only watch a specific set of extensions or exclude few. +Additionally to the replacement, Shopware-CLI allows only watching a specific set of extensions or exclude few. To only watch specific: @@ -62,7 +62,7 @@ For production, you should let this handle **supervisord** or **systemd**. But f ## Clear cache -It is just a short cut for `bin/console cache:clear` without having to be in the project root directory. +It is just a shortcut for `bin/console cache:clear` without having to be in the project root directory. ```bash shopware-cli project clear-cache @@ -90,7 +90,7 @@ It is similar to `bin/console system:generate-jwt-secret`, but requires no Shopw ## Admin API -If you want to make requests against the Shopware-API using curl, you need to obtain a JWT token and add it as a header. Shopware-CLI has a helper command for that: +If you want to make requests against the Shopware-API using curl, you need to get a JWT token and add it as a header. Shopware-CLI has a helper command for that: ```bash shopware-cli project admin-api --output-token diff --git a/products/cli/project-commands/mysql-dump.md b/products/cli/project-commands/mysql-dump.md index 749054e39..d69be5c97 100644 --- a/products/cli/project-commands/mysql-dump.md +++ b/products/cli/project-commands/mysql-dump.md @@ -35,7 +35,7 @@ By default Shopware-CLI will try to lock the table before dumping the data. This The `--anonymize` flag will anonymize known user data tables. The following tables are anonymized: -[See here for the complete list](https://github.com/FriendsOfShopware/shopware-cli/blob/main/cmd/project/project_dump.go#L74) +[See here for the complete list](https://github.com/shopware/shopware-cli/blob/main/cmd/project/project_dump.go#L74) It is possible to customize the anonymization process by using the `dump.rewrite` configuration in the `shopware-cli.yml` file. diff --git a/products/cli/project-commands/project-config-sync.md b/products/cli/project-commands/project-config-sync.md index e2d09f987..5b0256a49 100644 --- a/products/cli/project-commands/project-config-sync.md +++ b/products/cli/project-commands/project-config-sync.md @@ -7,9 +7,9 @@ nav: # Project config synchronization -Shopware-CLI can synchronize the project configurations between different environments. This is useful for example to keep the configuration in the development and production environment in sync. +Shopware-CLI can synchronize the project configurations between different environments. This is useful, for example, to keep the configuration in the development and production environment in sync. -Following things are possible to synchronize: +The Following things are possible to synchronize: - Theme Configuration - System Configuration (including extension configuration) @@ -65,8 +65,6 @@ This example synchronizes a new tax entity with the name `Tax` and the tax rate The further synchronizations will create the same entity again, you may want to fix the entity ID to avoid duplicates. -The further synchronizations will create the same entity again, you may want to fixed the entity ID to avoid duplicates. - ```yaml sync: entity: diff --git a/products/cli/shopware-account-commands/authentication.md b/products/cli/shopware-account-commands/authentication.md index 0872b5606..97f67c76b 100644 --- a/products/cli/shopware-account-commands/authentication.md +++ b/products/cli/shopware-account-commands/authentication.md @@ -9,7 +9,7 @@ nav: To interact with the Shopware Account API, you need to authenticate yourself. -For this you need to login using: +For this, you need to log in using: ```bash shopware-cli account login diff --git a/products/cli/shopware-account-commands/configure-composer-repository.md b/products/cli/shopware-account-commands/configure-composer-repository.md index 178a87e76..a1ebed288 100644 --- a/products/cli/shopware-account-commands/configure-composer-repository.md +++ b/products/cli/shopware-account-commands/configure-composer-repository.md @@ -20,7 +20,7 @@ If you don't see the shop you want to use, you need to switch to the correct com To create a `auth.json` file with the Composer repository configuration, you can use the following command: ::: info -You can also use the tab completion in terminal to get the domains of the shops you have access to. +You can also use the tab completion in the terminal to get the domains of the shops you have access to. ::: ```bash diff --git a/products/cli/shopware-account-commands/releasing-extension-to-shopware-store.md b/products/cli/shopware-account-commands/releasing-extension-to-shopware-store.md index 7786d1b6a..ce2554ef5 100644 --- a/products/cli/shopware-account-commands/releasing-extension-to-shopware-store.md +++ b/products/cli/shopware-account-commands/releasing-extension-to-shopware-store.md @@ -11,7 +11,7 @@ nav: - You are logged into the Shopware Store. Checkout the [Authentication](./authentication.md) guide for more information. - You have a zip file of your extensions with all assets. Checkout the [Creating a zip](../extension-commands/build.md) guide for more information. -- The zip file contains a `CHANGELOG*.md` file with an Changelog entry for the new version. Having a German changelog is optional. +- The zip file contains a `CHANGELOG*.md` file with a Changelog entry for the new version. Having a German changelog is optional. - You have validated the zip file with `shopware-cli extension validate `. See [Validating the zip](../extension-commands/validation.md) for more information. ## Releasing the extension @@ -24,4 +24,4 @@ shopware-cli account producer extension upload This command will check first if an extension with the same version already exists in the store. If not, it will upload the extension to the store. For the compatibility of the extension, the command will use the Composer constraint of `composer.json` or `maniofest.xml` file. -After the upload, the command will wait for the result of the automatic validation. This can take a few minutes. If the validation fails, the command will output the error message and you need to fix the issue and upload the extension again. You can skip this check with the `--skip-for-review-result` option. +After the upload, the command will wait for the result of the automatic validation. This can take a few minutes. If the validation fails, the command will output the error message, and you need to fix the issue and upload the extension again. You can skip this check with the `--skip-for-review-result` option. diff --git a/products/cli/shopware-account-commands/updating-store-page.md b/products/cli/shopware-account-commands/updating-store-page.md index eeee87a4d..8a22f6424 100644 --- a/products/cli/shopware-account-commands/updating-store-page.md +++ b/products/cli/shopware-account-commands/updating-store-page.md @@ -23,7 +23,7 @@ shopware-cli account producer extension info pull This will download all uploaded Store images and create a `.shopware-extension.yml` with all metadata of the extension. -This file can be checked-in into the version control and will be automatically removed when you create a zip file using Shopware-CLI. +This file can be checked in into the version control and will be automatically removed when you create a zip file using Shopware-CLI. ## Updating the Store page @@ -51,7 +51,7 @@ store: activate: de: false en: false - # Is the image an preview image, only one image can be a preview + # Is the image a preview image, only one image can be a preview preview: de: false en: false @@ -64,7 +64,7 @@ store: image_directory: ``` -The images will be sorted by the file name. If you want to seperate the images by language, you can create subdirectories with the language code like so: +The images will be sorted by the file name. If you want to separate the images by language, you can create subdirectories with the language code like so: ```text src/Resources/store/images/