Skip to content

Commit 631a9bd

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

File tree

3 files changed

+22
-17
lines changed

3 files changed

+22
-17
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
@@ -16,7 +16,7 @@ include::../modules/dynamic-plugins/con-understand-why-wiring-is-required.adoc[l
1616
include::../modules/dynamic-plugins/con-troubleshoot-why-a-dynamically-loaded-plugin-is-not-visible.adoc[leveloffset=+2]
1717

1818
// When to perform frontend wiring
19-
include::../modules/dynamic-plugins/con-identify-and-register-plugin-features-for-application-use.adoc[leveloffset=+2]
19+
include::../modules/dynamic-plugins/con-dynamic-front-end-plugins-for-application-use.adoc[leveloffset=+2]
2020

2121
// Extending the internal icon catalog
2222
include::../modules/dynamic-plugins/proc-extending-internal-icon-catalog.adoc[leveloffset=+1]

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,49 @@
11
:_mod-docs-content-type: CONCEPT
2-
[id="con-identify-and-register-plugin-features-for-application-use_{context}"]
2+
[id="con-dynamic-front-end-plugins-for-application-use_{context}"]
33

4-
= Identify and register plugin features for application use
4+
= Dynamic front-end plugins for application use
55

6-
Front-end wiring must be performed whenever a dynamic front-end plugin exports a feature that needs to be integrated into the main {product-custom-resource-type} application UI.
6+
Front-end wiring must be performed whenever a dynamic front-end plugin exports a feature for integration into the main {product-custom-resource-type} application UI.
77

88
Wiring is specifically required for, but not limited to, the following scenarios:
99

1010
[cols="1,1,2"]
1111
|===
1212
|Scenario|Wiring configuration|Description
1313

14-
|Enabling new pages/Routes
14+
|{installing-and-viewing-plugins-book-link}#proc-defining-dynamic-routes-for-new-plugin-pages.adoc_assembly-front-end-plugin-wiring[Enabling new pages/Routes]
1515
|`dynamicRoutes`
1616
|When adding a full new page and route to the application (for example, `/my-plugin`).
1717

18-
|Extending existing pages/UI
18+
|{installing-and-viewing-plugins-book-link}#proc-using-mount-points.adoc_assembly-front-end-plugin-wiring[Extending existing pages/UI]
1919
|`mountPoints`
2020
|When injecting custom widgets, cards, listeners, or providers into existing pages (for example, the Catalog entity page).
2121

22-
|Customizing sidebar navigation
22+
|{installing-and-viewing-plugins-book-link}#proc-defining-dynamic-routes-for-new-plugin-pages.adoc_assembly-front-end-plugin-wiring[Customizing sidebar navigation]
2323
|`dynamicRoutes.menuItem`, `menuItems`
2424
|When adding a new entry to the main sidebar or customizing its order/nesting.
2525

26-
|Integrating custom APIs
26+
|{installing-and-viewing-plugins-book-link}#proc-provide-additional-utility-apis.adoc_assembly-front-end-plugin-wiring[Integrating custom APIs]
2727
|`apiFactories`
2828
|When a plugin provides a custom utility API implementation or overrides an existing one.
2929

30-
|Extending entity tabs
30+
|{installing-and-viewing-plugins-book-link}#proc-customizing-and-extending-entity-tabs.adoc_assembly-front-end-plugin-wiring[Extending entity tabs]
3131
|`entityTabs`
3232
|When adding a new tab to the Catalog entity view or customizing an existing one.
3333

34-
|Binding routes
34+
|{installing-and-viewing-plugins-book-link}#proc-binding-to-existing-plugins.adoc_assembly-front-end-plugin-wiring[Binding routes]
3535
|`routeBindings`
3636
|When linking a route in one plugin to an external route defined by another plugin.
3737

38-
|Adding icons/Theming
38+
|{installing-and-viewing-plugins-book-link}#proc-extending-internal-icon-catalog.adoc_assembly-front-end-plugin-wiring[Adding icons/Theming]
3939
|`appIcons`, `themes`
4040
|When adding custom icons to the application catalog or defining a new {product-custom-resource-type} theme.
4141

42-
|Scaffolder/TechDocs extensions
42+
|{installing-and-viewing-plugins-book-link}#con-providing-custom-scaffolder-field-extensions.adoc_assembly-front-end-plugin-wiring[Scaffolder/TechDocs extensions]
4343
|`scaffolderFieldExtensions`, `techdocsAddons`
4444
|When exposing custom field extensions for the Scaffolder or new Addons for TechDocs.
4545

46-
|Translation resources
46+
|{installing-and-viewing-plugins-book-link}#proc-extensions-enabling-plugins-installation_rhdh-extensions-plugins[Translation resources]
4747
|`translationResources`
4848
|When providing new translation files or overriding default translations of a plugin.
4949
|===

modules/dynamic-plugins/con-troubleshoot-why-a-dynamically-loaded-plugin-is-not-visible.adoc

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,12 @@ If you skip front-end wiring, the plugin is discovered but not loaded into the a
77

88
You can expect the following behavior when you skip front-end wiring:
99

10-
Functionality is disabled:: The Backstage application does not know how to integrate the plugin exports.
11-
Invisible components:: New pages, sidebar links, or custom cards are not rendered.
12-
Unregistered APIs:: Custom utility APIs or API overrides provided by the plugin fail to register in the application API system, causing plugins or components to fail.
13-
Unused assets:: Icons, translations, and themes are not registered or made available for use.
10+
Disabled functionality:: The {product-custom-resource-type} application is unable to integrate or use the plugin exports.
11+
Invisible components:: New pages, sidebar links, or custom cards do not render in the application UI.
12+
Unregistered APIs:: Custom utility APIs or API overrides provided by the plugin are not registered in the application API system, potentially causing plugins or components to fail.
13+
Unused assets:: Icons, translations, and themes are not registered or made available for use.
14+
15+
[TIP]
16+
====
17+
Sometimes a plugin might not be visible even if there is front-end wiring, which indicates it is misconfigured. To troubleshoot this, check the *Console* tab in the _Developer Tools_ of your browser for specific error messages or warnings.
18+
====

0 commit comments

Comments
 (0)