Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Edit: added tip to update miactl before using it #1690

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Edit: added tip to update miactl before using it #1690

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f3bff37
Edit: added tip to update `miactl` before using it
Oct 1, 2024
db93987
Update docs/console/tutorials/create-extension.md
fredmaggiowski Oct 2, 2024
0df869e
Apply suggestions from code review
fredmaggiowski Oct 2, 2024
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
11 changes: 8 additions & 3 deletions docs/console/tutorials/create-extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,12 @@ This guide requires that you have:
- The response from the Backoffice endpoint can be embedded within an iframe. See this [link](/development_suite/api-console/api-design/endpoints.md#manage-advanced-endpoint-parameters) for more information.
- Miactl tool installed consulting the guide on this [link](/cli/miactl/20_setup.md)


## 1. Register Backoffice Extension

> **TIP:**
fredmaggiowski marked this conversation as resolved.
Show resolved Hide resolved
> Before proceeding make sure that `miactl` is updated to the latest version.
> Follow [setup `miactl`][setup-miactl] for more details.
fredmaggiowski marked this conversation as resolved.
Show resolved Hide resolved

Once that all requisites are satisfied, you can register the Backoffice as an extension using the following command:

```sh
Expand Down Expand Up @@ -78,7 +81,6 @@ These registered routes are rendered as a menu item with label `Integrated Backo
- not define the `category` field, so that the menu item will not be attached on any menu group
:::


**Response on success**
```markdown
Successfully applied extension with id `my-extension-id`
Expand Down Expand Up @@ -204,4 +206,7 @@ miactl extensions delete --endpoint https://<my-console-domain>/ --company-id my
Successfully deleted extension from Company
```

You can repeat [step 2](#2-check-that-the-new-extension-is-registered) to verify that the extension has been successfully removed.
You can repeat [step 2](#2-check-that-the-new-extension-is-registered) to verify that the extension has been successfully removed.

<!-- Links -->
[setup-miactl]: ../../cli/miactl/20_setup#installation
Loading