From f3bff373f8ac027d67866bc84d2cf9ca4d33c5da Mon Sep 17 00:00:00 2001 From: Daniele Marostica Date: Tue, 1 Oct 2024 17:30:28 +0200 Subject: [PATCH 1/3] Edit: added tip to update `miactl` before using it --- docs/console/tutorials/create-extension.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/console/tutorials/create-extension.md b/docs/console/tutorials/create-extension.md index 5ce35ddcd1..c329583887 100644 --- a/docs/console/tutorials/create-extension.md +++ b/docs/console/tutorials/create-extension.md @@ -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:** +> Before proceeding make sure that `miactl` is updated to the latest version. +> Follow [setup `miactl`][setup-miactl] for more details. + Once that all requisites are satisfied, you can register the Backoffice as an extension using the following command: ```sh @@ -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` @@ -204,4 +206,7 @@ miactl extensions delete --endpoint https:/// --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. \ No newline at end of file +You can repeat [step 2](#2-check-that-the-new-extension-is-registered) to verify that the extension has been successfully removed. + + +[setup-miactl]: ../../cli/miactl/20_setup#installation From db939878dcd1bbc7a7b4d19d1054847b9708f707 Mon Sep 17 00:00:00 2001 From: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com> Date: Wed, 2 Oct 2024 12:46:50 +0200 Subject: [PATCH 2/3] Update docs/console/tutorials/create-extension.md --- docs/console/tutorials/create-extension.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/console/tutorials/create-extension.md b/docs/console/tutorials/create-extension.md index c329583887..0d05cf0977 100644 --- a/docs/console/tutorials/create-extension.md +++ b/docs/console/tutorials/create-extension.md @@ -20,9 +20,10 @@ This guide requires that you have: ## 1. Register Backoffice Extension -> **TIP:** -> Before proceeding make sure that `miactl` is updated to the latest version. -> Follow [setup `miactl`][setup-miactl] for more details. +:::tip +Before proceeding make sure that `miactl` is updated to the latest version. +Follow [setup `miactl`][setup-miactl] for more details. +::: Once that all requisites are satisfied, you can register the Backoffice as an extension using the following command: From 0df869e4f036401b47dccc1872e8d1e9fa9fd310 Mon Sep 17 00:00:00 2001 From: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com> Date: Wed, 2 Oct 2024 12:47:28 +0200 Subject: [PATCH 3/3] Apply suggestions from code review --- docs/console/tutorials/create-extension.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/console/tutorials/create-extension.md b/docs/console/tutorials/create-extension.md index 0d05cf0977..d6dfc9ba42 100644 --- a/docs/console/tutorials/create-extension.md +++ b/docs/console/tutorials/create-extension.md @@ -22,7 +22,7 @@ This guide requires that you have: :::tip Before proceeding make sure that `miactl` is updated to the latest version. -Follow [setup `miactl`][setup-miactl] for more details. +Follow [`miactl` setup page][setup-miactl] for more details. ::: Once that all requisites are satisfied, you can register the Backoffice as an extension using the following command: