Skip to content

Commit 2fecab1

Browse files
GitHub Actionsjmagak
authored andcommitted
Apply new suggestions
1 parent 2c69a4f commit 2fecab1

File tree

6 files changed

+21
-21
lines changed

6 files changed

+21
-21
lines changed

assemblies/dynamic-plugins/assembly-front-end-plugin-wiring.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You can configure front-end plugins to customize icons, integrate components at
1010
include::../modules/dynamic-plugins/con-frontend-dynamic-plugin-wiring.adoc[leveloffset=+1]
1111

1212
// Understand frontend wiring
13-
include::../modules/dynamic-plugins/con-understand-why-wiring-is-required-for-plugin-deployment.adoc[leveloffset=+2]
13+
include::../modules/dynamic-plugins/con-understand-why-wiring-is-required.adoc[leveloffset=+2]
1414

1515
// When you skip frontend wiring
1616
include::../modules/dynamic-plugins/con-troubleshoot-why-a-dynamically-loaded-plugin-is-not-visible.adoc[leveloffset=+2]

modules/dynamic-plugins/con-identify-and-register-plugin-features-for-application-use.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ The application follows these steps when it loads:
7979

8080
. It parses the `dynamic-plugins-config.yaml`.
8181
. It uses the `<plugin_path_or_url>` to download the plugin bundle using the dynamic loading mechanism.
82-
. If the plugin exports the plugin object, the application adds this to the list of plugins provided to the Backstage `createApp` API, registering the plugin properly with the Backstage front-end application.
82+
. If the package exports the plugin object, the application adds it to the list provided to the {product-custom-resource-type} `createApp` API, registering the plugin properly with the front-end application.
8383
. It uses the configuration block (`dynamicRoutes`, `menuItem`) to:
8484
* Add an entry to the internal router mapping `/my-new-page` to the `FooPluginPage` component.
8585
* Construct and render a new sidebar item labeled _My Custom Page_, pointing to the `/my-new-page` route.

modules/dynamic-plugins/con-understand-why-wiring-is-required-for-plugin-deployment.adoc

Lines changed: 0 additions & 16 deletions
This file was deleted.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
:_mod-docs-content-type: CONCEPT
2+
[id="con-understand-why-wiring-is-required_{context}"]
3+
4+
= Understand why wiring is required
5+
6+
Dynamic front-end plugins load their code at runtime, but the {product-short} application does not automatically know where the components of a plugin must appear in the user interface (UI).
7+
8+
Front-end wiring provides the metadata and instructions that bridge this gap by telling the application the following:
9+
10+
* {installing-and-viewing-plugins-book-link}#proc-defining-dynamic-routes-for-new-plugin-pages.adoc_assembly-front-end-plugin-wiring[Add new pages and routes to the main application]. (using `dynamicRoutes`)
11+
* {installing-and-viewing-plugins-book-link}#proc-using-mount-points.adoc_assembly-front-end-plugin-wiring[Inject custom components into existing UI pages]. (using `mountPoints`)
12+
* {installing-and-viewing-plugins-book-link}#proc-extending-internal-icon-catalog.adoc_assembly-front-end-plugin-wiring[Configure application-wide customizations, such as new icons or themes]. (using `appIcons`)
13+
* {installing-and-viewing-plugins-book-link}#proc-customizing-sidebar-menu-items.adoc_assembly-front-end-plugin-wiring[Add new menu items]. (using `menuItems`)
14+
* {installing-and-viewing-plugins-book-link}#proc-binding-to-existing-plugins.adoc_assembly-front-end-plugin-wiring[Bind to existing plugins]. (using `routeBindings`)
15+
16+
Wiring configuration, typically located in `{my-app-config-file}` or `dynamic-plugins-config.yaml`, provides the application with the metadata (including the component names, paths, and integration points) needed to render and use the plugin features.

titles/plugins-rhdh-configure/master.adoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,3 @@ include::artifacts/attributes.adoc[]
77
:abstract: As a platform engineer, you can configure dynamic plugins in {product} ({product-very-short}) to access your development infrastructure or software development tools.
88

99
include::assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc[]
10-
11-
// frontend plugin wiring
12-
include::assemblies/dynamic-plugins/assembly-front-end-plugin-wiring.adoc[leveloffset=+1]

titles/plugins-rhdh-install/master.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,8 @@ include::assemblies/dynamic-plugins/assembly-extensions-plugins.adoc[leveloffset
3232
// Troubleshooting plugins
3333
include::modules/dynamic-plugins/proc-plugins-troubleshooting.adoc[leveloffset=+1]
3434

35+
// frontend plugin wiring
36+
include::assemblies/dynamic-plugins/assembly-front-end-plugin-wiring.adoc[leveloffset=+1]
37+
3538
// Plugin indicators and support types
3639
include::assemblies/dynamic-plugins/assembly-plugin-indicators-and-support-types.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)