Skip to content

Commit

Permalink
chore(docs): add dynamic plugins examples doc (#1978)
Browse files Browse the repository at this point in the history
This change adds a document to hold links to examples that have been
developed showing either how to use dynamic plugins or show off features
that are related to or enabled by dynamic plugins.

Signed-off-by: Stan Lewis <[email protected]>
  • Loading branch information
gashcrumb authored Nov 25, 2024
1 parent b2cd04d commit f87868e
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/dynamic-plugins/examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Examples

There are several example dynamic plugin projects that have been created to demonstrate various dynamic plugin related features. Here are some links to externally developed examples for further reference.

> [!WARNING]
> The following examples are maintained on a best-effort basis, some adjustments may be needed to get an example running, especially against a different target RHDH version.
## For RHDH 1.4 (pre-release)

- [Installing a custom middleware function using a dynamic plugin](https://github.com/gashcrumb/dynamic-plugins-root-http-middleware)

## For RHDH 1.3

- [A dynamic plugin containing a theme](https://github.com/gashcrumb/dynamic-plugins-getting-started-theme)

## For RHDH 1.2

- [A detailed getting started example](https://github.com/gashcrumb/dynamic-plugins-getting-started)
- [A way to expose a custom mount point from a plugin](https://github.com/gashcrumb/dynamic-plugins-getting-started-custom-mount-point)
- [A simple example showing how to embed packages](https://github.com/gashcrumb/dynamic-plugins-getting-started-dependency-embedding)
2 changes: 2 additions & 0 deletions docs/dynamic-plugins/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ More details about publishing dynamic plugins is in the [Packaging Dynamic Plugi

[Wrapping a third-party backend plugin to add dynamic plugin support](wrapping-plugins.md)

[Examples](examples.md)

## Installing external Backstage plugins into RHDH

1. Get the source code of the plugin.
Expand Down

0 comments on commit f87868e

Please sign in to comment.