Skip to content
New issue

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

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

Already on GitHub? # to your account

Improve copy #426

Merged
merged 1 commit into from
Oct 27, 2024
Merged
Changes from all commits
Commits
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
improve copy
wannevancamp committed Oct 27, 2024
commit ca3e9a35395b9abf161dd2b38dcbd9f9a6ad5d30
6 changes: 3 additions & 3 deletions wiki/docs/commands/account.md
Original file line number Diff line number Diff line change
@@ -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:

16 changes: 8 additions & 8 deletions wiki/docs/commands/extension.md
Original file line number Diff line number Diff line change
@@ -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.
14 changes: 7 additions & 7 deletions wiki/docs/commands/project.md
Original file line number Diff line number Diff line change
@@ -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
17 changes: 8 additions & 9 deletions wiki/docs/shopware-extension-yml-schema.md
Original file line number Diff line number Diff line change
@@ -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/<YourExtension>/.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
24 changes: 12 additions & 12 deletions wiki/docs/shopware-project-yml-schema.md
Original file line number Diff line number Diff line change
@@ -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: