Skip to content

Commit

Permalink
docs: enhance licensing and feature management information in commerc…
Browse files Browse the repository at this point in the history
…ial plugin
  • Loading branch information
shyim committed Jan 24, 2025
1 parent caf394c commit d99dd9c
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions products/plugins/commercial/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,35 @@ This plugin contains various features, which are covered in our docs as well.
::: warning
In accordance with a Shopware merchant's active account configuration, features within the plugin will be in *active* or *inactive* (whilst still being installed within the Shopware codebase). Pay close attention to any install information or special conditions for the provided features.
:::

## Licensing

On installation the commercial plugin tries to fetch the license key using the logged-in Shopware Account. If this can't be fetched, the plugin can be still installed but all features are deactivated. If you login into your Shopware Account, you can fetch again the license key using `bin/console commercial:license:update`.

Check warning on line 28 in products/plugins/commercial/index.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] products/plugins/commercial/index.md#L28

Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2[1]) Suggestions: `, but` URL: https://languagetool.org/insights/post/comma-before-and/ Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE_2?lang=en-US&subId=1 Category: PUNCTUATION
Raw output
products/plugins/commercial/index.md:28:166: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2[1])
 Suggestions: `, but`
 URL: https://languagetool.org/insights/post/comma-before-and/ 
 Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE_2?lang=en-US&subId=1
 Category: PUNCTUATION

Check warning on line 28 in products/plugins/commercial/index.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] products/plugins/commercial/index.md#L28

Did you mean the verb “log in” instead of the noun ‘login’? (LOG_IN[1]) Suggestions: `log in` URL: https://grammarist.com/spelling/log-in-login/ Rule: https://community.languagetool.org/rule/show/LOG_IN?lang=en-US&subId=1 Category: CONFUSED_WORDS
Raw output
products/plugins/commercial/index.md:28:208: Did you mean the verb “log in” instead of the noun ‘login’? (LOG_IN[1])
 Suggestions: `log in`
 URL: https://grammarist.com/spelling/log-in-login/ 
 Rule: https://community.languagetool.org/rule/show/LOG_IN?lang=en-US&subId=1
 Category: CONFUSED_WORDS

For further debugging you can run the command:

```bash
bin/console commercial:license:info
```

which will show the current license key if set and when it expires.

## Disable Features

::: info
This Feature is available since 6.6.10.0
:::

The commercial plugin consists of multiple features. You may not need all Features included with the plugin, so you can specify with `SHOPWARE_COMMERCIAL_ENABLED_BUNDLES` environment variable all commercial bundles you want to be enabled.

Example environment variable:

```text
SHOPWARE_COMMERCIAL_ENABLED_BUNDLES=CustomPricing,Subscription
```

You can find all bundle names using this command:

```bash
./bin/console debug:container --parameter kernel.bundles --format=json

Check warning on line 55 in products/plugins/commercial/index.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] products/plugins/commercial/index.md#L55

If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1]) Suggestions: ` Bundles`, ` bundles` Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1 Category: CASING
Raw output
products/plugins/commercial/index.md:55:49: If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
 Suggestions: ` Bundles`, ` bundles`
 Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
 Category: CASING
```

0 comments on commit d99dd9c

Please sign in to comment.