Skip to content

Commit

Permalink
docs: improve extensions command (#207)
Browse files Browse the repository at this point in the history
  • Loading branch information
fredmaggiowski authored Jun 25, 2024
1 parent 3a26ec1 commit d66bae9
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions docs/30_commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -597,7 +597,7 @@ The `extensions apply` command can be used to register new extensions or update
It accepts an Extension Manifest either in `yaml` or `json` format

<details>
<summary>Example JSON Manifest<summary>
<summary>Example JSON Manifest</summary>

```json
{
Expand Down Expand Up @@ -630,7 +630,7 @@ It accepts an Extension Manifest either in `yaml` or `json` format
</details>

<details>
<summary>Example YAML Manifest<summary>
<summary>Example YAML Manifest</summary>

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

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

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

### activate

The `extensions activate` command can be used to delete an existing extension.
The `extensions activate` command can be used to activate an existing extension.

:::tip
You can activate an extension on the whole Company or only for specific Projects.
If you activate it for the whole Company it will be inherited by all the Projects
Please note that, based on provided `contexts`, an extension can be activated for the whole Company or for specific Projects.

By using the `routes.locationId` option, you can specify where the extension is available, therefore
you can create an extension shown on the Project runtime and activate it for the whole Company context.
Such extension will be visible by all the Projects.

For further information checkout the [official documentation](https://docs.mia-platform.eu/docs/console/console-extensibility/extension-activation).
:::

Usage:
Expand All @@ -693,11 +698,11 @@ Available flags for the command:

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

### deactivate

The `extensions deactivate` command can be used to delete an existing extension.
The `extensions deactivate` command can be used to deactivate an existing extension.

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

0 comments on commit d66bae9

Please sign in to comment.