Skip to content

Commit 729b9b5

Browse files
committed
done
1 parent 90e5bf4 commit 729b9b5

File tree

11 files changed

+13
-25
lines changed

11 files changed

+13
-25
lines changed

.gitleaks.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ paths = [
1717
# Rest API old authentication
1818
'''content/rest-api/authentication_old.md''',
1919
# UI Extension documentation
20-
'''content/extensions/ui-extensions.md''',
20+
'''content/extensions/getting-started.md''',
2121
]

content/extensions/faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
Akeneo is responsible for the UI extensions framework itself, including the APIs and administrative interface. We provide support for these components. Your organization or your integrator is responsible for any custom code, iframes, or other custom development built within the UI extensions. Support for this custom code falls to your organization or integrator, not Akeneo.
44

55
### How can I add a new UI extension to my PIM?
6-
Adding a new extension to your organization is easy! Just follow the steps in [this guide](https://api.akeneo.com/extensions/ui-extensions.html#getting-started).
6+
Adding a new extension to your organization is easy! Just follow the steps in [this guide](https://api.akeneo.com/extensions/getting-started.html#getting-started).
77

88
### The UI extensions entry isn't showing up in my PIM. Could you help me understand why?
9-
If you don't see the UI extensions entry in your PIM, it's likely due to permission settings. [This guide](https://api.akeneo.com/extensions/ui-extensions.html#authorization) will help you check and activate the necessary permissions.
9+
If you don't see the UI extensions entry in your PIM, it's likely due to permission settings. [This guide](https://api.akeneo.com/extensions/getting-started.html#authorization) will help you check and activate the necessary permissions.
1010

1111
### I'd like to see my extension in a position that isn't currently available. What can I do?
1212
Currently, UI extension placements are limited to those defined by Akeneo. However, we highly value your feedback! Please contact your Customer Success Manager or our Support team to share your specific placement needs. This will help us understand your use case and consider it for future development.

content/extensions/ui-extensions.md renamed to content/extensions/getting-started.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
# UI extensions
1+
# Getting Started
22
The UI extension feature enables you to extend your PIM by integrating custom views and actions from external systems. This framework provides the flexibility to modify and adapt your PIM experience to meet specific business requirements.
33
By leveraging this functionality, you can integrate custom solutions while maintaining the reliability and ease the use of our SaaS platform, offering a balance between flexibility and stability.
44

55
The extension framework is designed to help you customize the standard behavior of your PIM system by integrating with externally hosted solutions. This documentation provides an overview of the framework's capabilities and the various customization options available, enabling you to extend and tailor your PIM to meet your specific business needs.
66

7-
## Getting Started
87
This guide provides a step-by-step walkthrough for setting up and managing UI extensions.
98

109
### Prerequisites
@@ -513,20 +512,11 @@ On the new page, you can see all extensions registered in your PIM.
513512

514513
To manage one or more UI extensions from the list, you just have to select them thanks to the checkboxes present on the left of each line, and then use one of the two commands available at the bottom of the screen.
515514

516-
### Filter UI extension by user groups
517-
518-
You can filter the user groups allowed to see and execute an UI extension by using the permissions tab on the UI extensions creation/edition form.
519-
520-
### Filter UI extension by product selection
521-
You can filter the products that can be selected by an UI extension by using the product selection tab on the UI extensions creation/edition form.
522-
523-
[![ui-extension-product-selection.png](../img/extensions/ui-extensions/ui-extension-product-selection.png)](../img/extensions/ui-extensions/ui-extension-product-selection.png)
524-
525515
## API reference
526516
Several choices are offered to deep dive into our API, to discover all the endpoints, and their request/response schema:
527517

528518
- You can <a href="https://api.akeneo.com/api-reference-index.html#UIExtensions" target="_blank">consult this static documentation</a>
529-
- Discover it thanks to <a href="https://api.akeneo.com/files/Akeneo%20PIM%20API.postman_collection.json" target="_blank">the postman collection</a> (see the [Postman section](https://api.akeneo.com/extensions/ui-extensions.html#using-postman))
519+
- Discover it thanks to <a href="https://api.akeneo.com/files/Akeneo%20PIM%20API.postman_collection.json" target="_blank">the postman collection</a> (see the [Postman section](https://api.akeneo.com/extensions/getting-started.html#using-postman))
530520

531521
::: panel-link UI extensions available positions [Next](/extensions/positions.html)
532522
:::

content/extensions/positions.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Positions
22

3-
**Extension Positions**
4-
53
Extension position determines where your extension appears within the Akeneo PIM interface. You can select from a variety of available positions, which vary depending on the specific extension type.
64

75
**Key Concepts:**

content/swagger/akeneo-web-api.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
type: object
2-
description: Configuration options that are specific to the UI extension <a href='extensions/ui-extensions.html#type'>type</a>
2+
description: Configuration options that are specific to the UI extension <a href='extensions/getting-started.html#type'>type</a>
33
properties:
44
default_label:
55
type: string
@@ -9,7 +9,7 @@ properties:
99
description: Label translations
1010
secret:
1111
type: string
12-
description: Shows ***REDACTED*** if a <a href='extensions/ui-extensions.html#secret'>secret</a> is registered for the extension
12+
description: Shows ***REDACTED*** if a <a href='extensions/getting-started.html#secret'>secret</a> is registered for the extension
1313
url:
1414
type: string
1515
description: Destination URL of the extension
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
type: string
2-
description: <a href='extensions/ui-extensions.html#position'>Position</a> of the UI extension
2+
description: <a href='extensions/getting-started.html#position'>Position</a> of the UI extension
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
type: string
2-
description: <a href='extensions/ui-extensions.html#type'>Type</a> of the UI extension
2+
description: <a href='extensions/getting-started.html#type'>Type</a> of the UI extension

content/swagger/resources/ui_extensions/routes/ui_extensions.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ post:
2828
x-versions:
2929
- "SaaS"
3030
x-ee: true
31-
description: This endpoint allows you to create a new UI extension. <code>default_label</code> and <code>url</code> configuration fields are mandatory for all UI extensions. <code>secret</code> is optional and only available for <a href='extensions/ui-extensions.html#action'>action</a> UI extension.
31+
description: This endpoint allows you to create a new UI extension. <code>default_label</code> and <code>url</code> configuration fields are mandatory for all UI extensions. <code>secret</code> is optional and only available for <a href='extensions/getting-started.html#action'>action</a> UI extension.
3232
parameters:
3333
- name: body
3434
in: body

src/partials/layout.handlebars

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
173173
</li>
174174
<li>
175175
<ul>
176-
<li><a href="/extensions/ui-extensions.html">UI Extensions</a></li>
176+
<li><a href="/extensions/getting-started.html">UI Extensions</a></li>
177177
</ul>
178178
</li>
179179
<li>

0 commit comments

Comments
 (0)