Skip to content

Commit

Permalink
edit(IDP-1203): Move Extension Tutorial (#1403)
Browse files Browse the repository at this point in the history
* Edit(IDP-1203): Move Extension Tutorial

* Added redirect
  • Loading branch information
MIA-Deltat1995 authored May 21, 2024
1 parent a1647f6 commit 1213372
Show file tree
Hide file tree
Showing 14 changed files with 18 additions and 14 deletions.
4 changes: 4 additions & 0 deletions 301redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -1710,5 +1710,9 @@
"/docs/runtime_suite_applications/control-plane/changelog": {
"destination": "/docs/runtime_suite_applications/fast-data-control-plane/changelog",
"addedOn": "2024-05-09"
},
"/docs/console/console-extensibility/extension-example-tutorial": {
"destination": "/docs/console/tutorials/create-extension-tutorial",
"addedOn": "2024-05-20"
}
}
4 changes: 2 additions & 2 deletions docs/console/console-extensibility/activation.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The activation can be done using the API `POST /api/extensibility/tenants/{tenan
Activation at the Project level can only be done on a project within the same Company on which the extension is registered.
:::

See the example on the [getting started guide](/console/console-extensibility/tutorial.md#3-activate-the-extension)
See the example on the [getting started guide](/console/tutorials/create-extension.md#3-activate-the-extension)

## Overrides

Expand Down Expand Up @@ -59,4 +59,4 @@ An extension activation can be terminated at any point using the API `DELETE /ap
204 No Content
```

See the example on the [getting started guide](/console/console-extensibility/tutorial.md#5-deactivate-the-backoffice-extension)
See the example on the [getting started guide](/console/tutorials/create-extension.md#5-deactivate-the-backoffice-extension)
2 changes: 1 addition & 1 deletion docs/console/console-extensibility/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The activation of a new extension in the Console involves two phases:
`Registration` allows you to add an extension for the first time and provide all the essential information necessary for the extension to work, such as the URL for fetching the iframe and the different locations where the new menu items should be placed.
`Activation`, on the other hand, allows you to activate an extension already registered on a specific Console context and in this way the same extension can be active on multiple contexts at the same time, such as multiple projects for example.

Consult the [tutorial](/console/console-extensibility/tutorial.md) to take your first steps.
Consult the [tutorial](/console/tutorials/create-extension.md) to take your first steps.

## Advanced concepts: Security and Customization

Expand Down
8 changes: 4 additions & 4 deletions docs/console/console-extensibility/registration.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The route to contact is `PUT /api/extensibility/tenants/{tenantId}/extensions`,
**Response**
- `extensionId`: the extension identifies needed to manage the registered extension

See the example on the [getting started guide](/console/console-extensibility/tutorial.md#1-register-backoffice-extension)
See the example on the [getting started guide](/console/tutorials/create-extension.md#1-register-backoffice-extension)

### How to restrict the extension usage?

Expand Down Expand Up @@ -69,7 +69,7 @@ Array of registered extensions metadata:
- `name`: extension name
- `description`: extension description

See the example on the [getting started guide](/console/console-extensibility/tutorial.md#2-check-that-the-new-extension-is-registered)
See the example on the [getting started guide](/console/tutorials/create-extension.md#2-check-that-the-new-extension-is-registered)

## Edit registered Extension

Expand All @@ -93,7 +93,7 @@ The route `PUT /api/extensibility/tenants/{tenantId}/extensions` can be used to
204 No Content
```

See the example on the [getting started guide](/console/console-extensibility/tutorial.md#edit-the-registered-extension)
See the example on the [getting started guide](/console/tutorials/create-extension.md#edit-the-registered-extension)

## Remove registered Extension

Expand All @@ -112,4 +112,4 @@ Deleting an extension automatically deactivates it from all contexts where it wa
204 No Content
```

See the example on the [getting started guide](/console/console-extensibility/tutorial.md#6-remove-definitely-the-backoffice-extension)
See the example on the [getting started guide](/console/tutorials/create-extension.md#6-remove-definitely-the-backoffice-extension)
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
id: extension-example-tutorial
id: create-extension-tutorial
title: Getting started
sidebar_label: Getting started
sidebar_label: Create your extension
---

# Getting started: Extend your Console
# Create your extension

Following this tutorial you will learn how to add the Backoffice as an extension within a Project, in order to consult it directly from the Console.

Expand Down
8 changes: 4 additions & 4 deletions sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,10 @@
{
"id": "console/tutorials/protect-your-endpoints-with-policies",
"type": "doc"
},
{
"id": "console/tutorials/create-extension-tutorial",
"type": "doc"
}
]
},
Expand Down Expand Up @@ -657,10 +661,6 @@
"id": "console/console-extensibility/extensibility-overview",
"type": "doc"
},
{
"id": "console/console-extensibility/extension-example-tutorial",
"type": "doc"
},
{
"id": "console/console-extensibility/extension-registration",
"type": "doc"
Expand Down

0 comments on commit 1213372

Please sign in to comment.