Skip to content

Commit a1a8bf9

Browse files
gashcrumbrohitkrai03claude
authored
chore(docs): add frontend migration guides (#5009)
* chore(docs): add frontend migration guides This change adds a couple migration guides to help plugin developers and RHDH operators better understand the changes required to adopt the new frontend system once it's made the default in RHDH. Assisted-By: Cursor Desktop * docs: add gotchas, API changes, drawer blueprint, and reference PRs - Fix drawer section: AppDrawerContentBlueprint exists in RHDH (not "pending NFS design") - Add translation module pluginId: 'app' requirement - Add API breaking changes (param renames, makeWithOverrides deprecation) - Add 3 common gotchas (defineParams wrapper, double headers, default export) - Add reference migration PRs table (8 rhdh-plugins PRs) - Add dev app setup for Phase 3 validation Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Rohit Rai <rohitkrai03@gmail.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 5c9e678 commit a1a8bf9

4 files changed

Lines changed: 1983 additions & 0 deletions

File tree

docs/dynamic-plugins/frontend-plugin-wiring.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Frontend Plugin Wiring
22

3+
> **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:
4+
>
5+
> - **Operators / platform admins** (YAML customization only) → [Migrating Config to the New Frontend System](migrating-config-to-new-frontend-system.md)
6+
> - **Plugin authors** (plugin code and `/alpha` exports) → [Migrating Plugins to the New Frontend System](migrating-plugins-to-new-frontend-system.md)
7+
38
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.
49

510
Similarly to traditional Backstage instances, there are various kinds of functionality a dynamic frontend plugin can offer:

docs/dynamic-plugins/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ More details about publishing dynamic plugins is in the [Packaging Dynamic Plugi
2121

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

24+
[Migrating Plugins to the New Frontend System](migrating-plugins-to-new-frontend-system.md)
25+
26+
[Migrating Config to the New Frontend System](migrating-config-to-new-frontend-system.md)
27+
2428
[Local configuration (for development only)](local.md)
2529

2630
[Version Compatibility Matrix](versions.md)

0 commit comments

Comments
 (0)