From f87868ec971209a828426a2d3ce4fc1515740d24 Mon Sep 17 00:00:00 2001 From: Stan Lewis Date: Mon, 25 Nov 2024 10:18:45 -0500 Subject: [PATCH] chore(docs): add dynamic plugins examples doc (#1978) 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 --- docs/dynamic-plugins/examples.md | 20 ++++++++++++++++++++ docs/dynamic-plugins/index.md | 2 ++ 2 files changed, 22 insertions(+) create mode 100644 docs/dynamic-plugins/examples.md diff --git a/docs/dynamic-plugins/examples.md b/docs/dynamic-plugins/examples.md new file mode 100644 index 0000000000..6e1a8b828e --- /dev/null +++ b/docs/dynamic-plugins/examples.md @@ -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) \ No newline at end of file diff --git a/docs/dynamic-plugins/index.md b/docs/dynamic-plugins/index.md index 13e4dc4b57..1656b5fb8a 100644 --- a/docs/dynamic-plugins/index.md +++ b/docs/dynamic-plugins/index.md @@ -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.