From ca3e9a35395b9abf161dd2b38dcbd9f9a6ad5d30 Mon Sep 17 00:00:00 2001 From: Wanne Van Camp Date: Sun, 27 Oct 2024 09:56:30 +0100 Subject: [PATCH] improve copy --- wiki/docs/commands/account.md | 6 +++--- wiki/docs/commands/extension.md | 16 +++++++-------- wiki/docs/commands/project.md | 14 ++++++------- wiki/docs/shopware-extension-yml-schema.md | 17 ++++++++------- wiki/docs/shopware-project-yml-schema.md | 24 +++++++++++----------- 5 files changed, 38 insertions(+), 39 deletions(-) diff --git a/wiki/docs/commands/account.md b/wiki/docs/commands/account.md index 17f1b1d7..c8bb4f84 100644 --- a/wiki/docs/commands/account.md +++ b/wiki/docs/commands/account.md @@ -5,7 +5,7 @@ weight: 20 ### shopware-cli account login -This command can be used to log in into your Shopware account. If you are in multiple companies, see `Account Company Use` command +This command can be used to log in to your Shopware account. If you are in multiple companies, see `Account Company Use` command. ### shopware-cli account logout @@ -25,7 +25,7 @@ Parameters: ### shopware-cli account producer info -Lists some basic information about the logged in producer +Lists some basic information about the logged-in producer. ### shopware-cli account producer extension list @@ -50,7 +50,7 @@ Parameters: ### shopware-cli account producer extension upload -Upload a extension release to the Store. +Upload an extension release to the Store. Parameters: diff --git a/wiki/docs/commands/extension.md b/wiki/docs/commands/extension.md index 1a6cef2c..556a380c 100644 --- a/wiki/docs/commands/extension.md +++ b/wiki/docs/commands/extension.md @@ -23,15 +23,15 @@ Parameters: ## shopware-cli extension zip -Creates a zip file from extension folder +Creates a zip file from the extension folder. Parameters: -* path - Path to extension folder. F.e: `shopware-cli extension zip MyPlugin` +* path - Path to extension folder. For example: `shopware-cli extension zip MyPlugin`. Environment-Variables: -* SHOPWARE_PROJECT_ROOT (optional) - Path to a installed shopware to speed up building. F.e: `SHOPWARE_PROJECT_ROOT=/var/www/myshop/ shopware-cli extension zip MyPlugin` +* SHOPWARE_PROJECT_ROOT (optional) - Path to an installed Shopware to speed up building. For example: `SHOPWARE_PROJECT_ROOT=/var/www/myshop/ shopware-cli extension zip MyPlugin`. ## shopware-cli extension build @@ -40,16 +40,16 @@ Builds the JS and CSS assets into the extension folder Parameters: -* path - Path to extension folder. This can be also multiple directories. F.e: `SHOPWARE_PROJECT_ROOT=/var/www/myshop/ shopware-cli extension build MyPlugin MySecondPlugin` +* path - Path to extension folder. This can be also multiple directories. For example: `SHOPWARE_PROJECT_ROOT=/var/www/myshop/ shopware-cli extension build MyPlugin MySecondPlugin`. Environment-Variables: -* SHOPWARE_PROJECT_ROOT (optional) - Path to a installed shopware to speed up building. F.e: `SHOPWARE_PROJECT_ROOT=/var/www/myshop/ shopware-cli extension build MyPlugin` +* SHOPWARE_PROJECT_ROOT (optional) - Path to an installed Shopware to speed up building. For example: `SHOPWARE_PROJECT_ROOT=/var/www/myshop/ shopware-cli extension build MyPlugin`. ## shopware-cli extension admin-watch -Starts a admin-watcher using ESBuild to build the JS and CSS assets into the extension folder +Starts an admin-watcher using ESBuild to build the JS and CSS assets into the extension folder. Parameters: @@ -71,7 +71,7 @@ Arguments: Parameters: -* `--german` - Get the german changelog +* `--german` - Get the German changelog. ## shopware-cli extension get-version @@ -83,4 +83,4 @@ Arguments: Parameters: -* `--german` - Get the german changelog +* `--german` - Get the German changelog. \ No newline at end of file diff --git a/wiki/docs/commands/project.md b/wiki/docs/commands/project.md index 28eb6d2b..62100541 100644 --- a/wiki/docs/commands/project.md +++ b/wiki/docs/commands/project.md @@ -5,7 +5,7 @@ weight: 30 ## shopware-cli project create [folder] [version] -Create a new Shopware 6 project from the choosen version +Create a new Shopware 6 project from the chosen version Arguments: @@ -27,8 +27,8 @@ Starts the Administration watcher Parameters: -* `--only-extensions` - Only consider given list of extensions for the watcher (comma separated list) -* `--skip-extensions` - Skip given list of extensions for the watcher (comma separated list) +* `--only-extensions` - Only consider given list of extensions for the watcher (comma-separated list) +* `--skip-extensions` - Skip given list of extensions for the watcher (comma-separated list) ## shopware-cli project storefront-build @@ -45,12 +45,12 @@ Starts the Storefront watcher Parameters: -* `--only-extensions` - Only consider given list of extensions for the watcher (comma separated list) -* `--skip-extensions` - Skip given list of extensions for the watcher (comma separated list) +* `--only-extensions` - Only consider given list of extensions for the watcher (comma-separated list) +* `--skip-extensions` - Skip given list of extensions for the watcher (comma-separated list) ## shopware-cli project worker -Starts the Shopware worker in background and tails the log +Starts the Shopware worker in the background and tails the log Parameters: @@ -72,7 +72,7 @@ dump: rewrite: table: column: "'new-value'" - colum2: "faker.Internet().Email()" # Uses faker data. See https://github.com/jaswdr/faker + column2: "faker.Internet().Email()" # Uses faker data. See https://github.com/jaswdr/faker # Ignore table content nodata: - table diff --git a/wiki/docs/shopware-extension-yml-schema.md b/wiki/docs/shopware-extension-yml-schema.md index 0ca6ce4b..37bb31b7 100644 --- a/wiki/docs/shopware-extension-yml-schema.md +++ b/wiki/docs/shopware-extension-yml-schema.md @@ -1,15 +1,15 @@ --- - title: 'Schema of .shopware-extension.yml' + title: 'Schema of .shopware-extension.yml' --- -Any configuration field is optional. When you create a `.shopware-extension.yml`, you get also IDE autocompletion for all fields. +Any configuration field is optional. When you create a `.shopware-extension.yml`, you also get IDE autocompletion for all fields. Put the `.shopware-extension.yml` inside the root directory of your extension: `/var/www/myshop/custom/plugins//.shopware-extension.yml` ```yaml # .shopware-extension.yml build: - # override the auto detection of the shopware constraint + # override the auto-detection of the shopware constraint shopwareVersionConstraint: `~6.5.0` # build additional bundles for assets @@ -48,7 +48,7 @@ build: # use bundled esbuild instead of default compile enable_es_build_for_storefront: false - + # all package.json of this extension will be installed with `npm install --production`, therefore, devDependencies will be ignored npm_strict: false @@ -114,22 +114,21 @@ store: - ... faq: - - question: Can do the extension this ? - answer: Yes, we can .... - + - question: Can the extension do this? + answer: Yes, it can .... description: # inline en: | Write inline - # embedd an html or markdown file + # embed an html or markdown file de: file:src/Resources/store/description.md installation_manual: # inline en: | Write inline - # embedd an html or markdown file + # embed an html or markdown file de: file:src/Resources/store/manual.md # Similar to images, but automatically picks all files from that directory diff --git a/wiki/docs/shopware-project-yml-schema.md b/wiki/docs/shopware-project-yml-schema.md index 9642f842..c1a8a308 100644 --- a/wiki/docs/shopware-project-yml-schema.md +++ b/wiki/docs/shopware-project-yml-schema.md @@ -8,37 +8,37 @@ Any configuration field is optional. When you create a `.shopware-project.yml`, ```yaml # .shopware-project.yml -# URL to Shopware instance, required for admin api calls (clear cache, sync stuff) +# URL to Shopware instance, required for admin API calls (clear cache, sync stuff) url: 'http://localhost' admin_api: - # For integration use this both fields + # For integration use these two fields client_id: client_secret: - # For normal user use this both fields + # For normal user use these two fields username: password: - # When your server don't have a valid SSL certificate, you can disable the SSL check + # When your server doesn't have a valid SSL certificate, you can disable the SSL check disable_ssl_check: false -# used only for project ci command +# used only for project CI command build: - # deletes all public source folders of all extensions, can be only used when /bundles is served from local and not external CDN + # deletes all public source folders of all extensions, can only be used when /bundles is served from local and not external CDN remove_extension_assets: false # skips the bin/console asset:install part disable_asset_copy: false # when enabled src/Resources/app/{storefront/administration} folder will be preserved and not deleted. - # If your plugin requires, you should move the files out of src/Resources which needs to be accessed by php and js + # If your plugin requires, you should move the files out of src/Resources which need to be accessed by PHP and JS keep_extension_source: false # delete additional paths after build cleanup_paths: - path # change the browserslist of the storefront build, see https://browsersl.ist for the syntax as string (example: defaults, not dead) browserslist: '' - # exclude extensions to be built by shopware-cli, only their PHP code will be shipped without any css/js + # exclude extensions to be built by shopware-cli, only their PHP code will be shipped without any CSS/JS exclude_extensions: - name -# used for mysql dump creation +# used for MySQL dump creation dump: # rewrite columns rewrite: @@ -57,13 +57,13 @@ dump: # you can use shopware-cli project config pull, to get your current shop state sync: - # Sync system config to your remote shop using admin-api + # Sync system config to your remote shop using admin API config: # can be also null for default value - - sales_channel: yourSalesChannelid + - sales_channel: yourSalesChannelId settings: my_config: myValue - # Sync theme config to your remote shop using admin-api + # Sync theme config to your remote shop using admin API theme: - name: ThemeName settings: