Skip to content

chore(docs): add frontend migration guides #5009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gashcrumb wants to merge 1 commit into
base: main
Choose a base branch
from
+1,808 −0
Open

chore(docs): add frontend migration guides #5009

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/dynamic-plugins/frontend-plugin-wiring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Frontend Plugin Wiring

> **Legacy configuration reference.** This document describes RHDH dynamic plugin frontend wiring for the **current** app shell. If you are moving to the Backstage new frontend system, use:
>
> - **Operators / platform admins** (YAML customization only) → [Migrating Config to the New Frontend System](migrating-config-to-new-frontend-system.md)
> - **Plugin authors** (plugin code and `/alpha` exports) → [Migrating Plugins to the New Frontend System](migrating-plugins-to-new-frontend-system.md)

Compared to the backend plugins, where mount points are defined in code and consumed by the backend plugin manager, frontend plugins require additional configuration in the `app-config.yaml`. A plugin missing this configuration will not be loaded into the application and will not be displayed.

Similarly to traditional Backstage instances, there are various kinds of functionality a dynamic frontend plugin can offer:
Expand Down
4 changes: 4 additions & 0 deletions docs/dynamic-plugins/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ More details about publishing dynamic plugins is in the [Packaging Dynamic Plugi

[Frontend Plugin Wiring](frontend-plugin-wiring.md)

[Migrating Plugins to the New Frontend System](migrating-plugins-to-new-frontend-system.md)

[Migrating Config to the New Frontend System](migrating-config-to-new-frontend-system.md)

[Local configuration (for development only)](local.md)

[Version Compatibility Matrix](versions.md)
Expand Down
Loading
Loading