Skip to content

Commit d66bae9

Browse files
docs: improve extensions command (#207)
1 parent 3a26ec1 commit d66bae9

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

docs/30_commands.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -597,7 +597,7 @@ The `extensions apply` command can be used to register new extensions or update
597597
It accepts an Extension Manifest either in `yaml` or `json` format
598598

599599
<details>
600-
<summary>Example JSON Manifest<summary>
600+
<summary>Example JSON Manifest</summary>
601601

602602
```json
603603
{
@@ -630,7 +630,7 @@ It accepts an Extension Manifest either in `yaml` or `json` format
630630
</details>
631631

632632
<details>
633-
<summary>Example YAML Manifest<summary>
633+
<summary>Example YAML Manifest</summary>
634634

635635
```yaml
636636
name: "Extension 1"
@@ -667,7 +667,7 @@ Available flags for the command:
667667
- `--extension-id` to set the ID of the extension Company, required for updating an existing extension.
668668

669669
:::tip
670-
In order to specify whether a create or an update is needed you have to use the `--extension-id` 
670+
In order to specify whether a create or an update is needed you have to use the `--extension-id`
671671
flag or specify the `extensionId` property in the manifest file.
672672

673673
You can get the **extension id** by using the [extensions list](#list-5) command or
@@ -676,11 +676,16 @@ in the apply response after creating the extension.
676676

677677
### activate
678678

679-
The `extensions activate` command can be used to delete an existing extension.
679+
The `extensions activate` command can be used to activate an existing extension.
680680

681681
:::tip
682-
You can activate an extension on the whole Company or only for specific Projects.
683-
If you activate it for the whole Company it will be inherited by all the Projects
682+
Please note that, based on provided `contexts`, an extension can be activated for the whole Company or for specific Projects.
683+
684+
By using the `routes.locationId` option, you can specify where the extension is available, therefore
685+
you can create an extension shown on the Project runtime and activate it for the whole Company context.
686+
Such extension will be visible by all the Projects.
687+
688+
For further information checkout the [official documentation](https://docs.mia-platform.eu/docs/console/console-extensibility/extension-activation).
684689
:::
685690

686691
Usage:
@@ -693,11 +698,11 @@ Available flags for the command:
693698

694699
- `--company-id` to set the ID of the desired Company
695700
- `--project-id` to set the ID of the desired project, if specified, the extension will be activated only for this project only
696-
- `--extension-id` **required** to set the ID of the extension.
701+
- `--extension-id` **required** to set the ID of the extension
697702

698703
### deactivate
699704

700-
The `extensions deactivate` command can be used to delete an existing extension.
705+
The `extensions deactivate` command can be used to deactivate an existing extension.
701706

702707
:::tip
703708
Please note that if an extension has been activated on the whole Company it can't be deactivated on a specific Project;

0 commit comments

Comments
 (0)