RHIDP-8634-2-1-8 - Improve the documentation to help developers convert plugins to dynamic plugins (redhat-developer#1514)

Author: Gerry-Forde

assemblies/dynamic-plugins/assembly-install-third-party-plugins-rhdh.adoc

@@ -1,10 +1,10 @@
 :_mod-docs-content-type: ASSEMBLY
 
 [id="assembly-install-third-party-plugins-rhdh"]
-= Installing third-party plugins in {product}
+= Installing {plugin-type-name} plugins in {product}
 :context: assembly-install-third-party-plugins-rhdh
 
-You can install a third-party plugins in {product} without rebuilding the {product-very-short} application.
+You can install a {plugin-type-name} plugins in {product} without rebuilding the {product-very-short} application.
 
 The location of the `dynamic-plugin-config.yaml` file depends on the deployment method. For more details, refer to xref:proc-config-dynamic-plugins-rhdh-operator_rhdh-installing-rhdh-plugins[Installing dynamic plugins with the {product} Operator] and xref:con-install-dynamic-plugin-helm_rhdh-installing-rhdh-plugins[Installing dynamic plugins using the Helm chart].
 
@@ -30,5 +30,5 @@ include::../modules/dynamic-plugins/proc-load-plugin-tgz-file.adoc[leveloffset=+
 include::../modules/dynamic-plugins/proc-load-plugin-js-package.adoc[leveloffset=+2]
 
 //example third-party plugin installation
-include::../modules/dynamic-plugins/proc-example-third-party-plugin-installation.adoc[leveloffset=+2]
+//include::../modules/dynamic-plugins/proc-example-third-party-plugin-installation.adoc[leveloffset=+2]
 

assemblies/dynamic-plugins/assembly-package-publish-third-party-dynamic-plugin.adoc

@@ -1,10 +1,10 @@
 :_mod-docs-content-type: ASSEMBLY
 
 [id="assembly-package-publish-third-party-dynamic-plugin"]
-= Packaging and publishing third-party plugins as dynamic plugins
+= Packaging and publishing {plugin-type-name} plugins as dynamic plugins
 :context: assembly-package-publish-third-party-dynamic-plugin
 
-After xref:proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[exporting a third-party plugin], you can package the derived package into one of the following supported formats:
+After xref:proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[exporting a {plugin-type-name} plugin], you can package the derived package into one of the following supported formats:
 
 * Open Container Initiative (OCI) image (recommended)
 * TGZ file

assemblies/dynamic-plugins/assembly-third-party-plugins.adoc

@@ -1,14 +1,14 @@
 :_mod-docs-content-type: ASSEMBLY
 
 [id="assembly-third-party-plugins"]
-= Third-party plugins in {product}
+= {plugin-type-name-uppercase} plugins in {product}
 :context: assembly-third-party-plugins
 
-You can integrate third-party dynamic plugins into {product} to enhance its functionality without modifying its source code or rebuilding it. To add these plugins, export them as derived packages.
+You can integrate {plugin-type-name} dynamic plugins into {product} to enhance its functionality without modifying its source code or rebuilding it. To add these plugins, export them as derived packages.
 
 While exporting the plugin package, you must ensure that dependencies are correctly bundled or marked as shared, depending on their relationship to the {product-short} environment.
 
-To integrate a third-party plugin into {product-short}:
+To integrate a {plugin-type-name} plugin into {product-short}:
 
 . First, obtain the plugin's source code.
 . Export the plugin as a dynamic plugin package. See xref:proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[].
@@ -24,5 +24,10 @@ include::assembly-package-publish-third-party-dynamic-plugin.adoc[leveloffset=+1
 //Install third-party plugin
 include::assembly-install-third-party-plugins-rhdh.adoc[leveloffset=+1]
 
+include::../modules/dynamic-plugins/proc-custom-plugin-conversion.adoc[leveloffset=+1]
+
+include::../modules/dynamic-plugins/proc-custom-plugin-add-to-rhdh.adoc[leveloffset=+2]
+
+include::../modules/dynamic-plugins/proc-displaying-frontend-plugin.adoc[leveloffset=+2]
 
 

images/rhdh/custom-container-images.png

@@ -0,0 +1,16 @@
+:_mod-docs-content-type: CONCEPT
+
+[id="con-converting-custom-plugins"]
+= Dynamic Plugins
+{product} implements a dynamic plugin system. You can install, configure, and load plugins at runtime without changing or rebuilding the application. You only need a restart. You can load these plugins from NPM, tarballs, or OCI compliant container images.
+
+With dynamic plugins, instead of modifying the {backstage} application itself, you create a `dynamic-plugins.yaml` file to specify the plugins that {product} will install and enable at startup. For example, the following configuration loads a plugin named `plugin-name`, which is stored in a `Quay.io` container image at `quay.io/account-name/image-name`:
+
+.`dynamic-plugins.yaml` fragment
+[source,yaml]
+----
+plugins:
+  - package: oci://quay.io/account-name/image-name:tag!plugin-name
+    disabled: false
+    pluginConfig: {}
+----

images/rhdh/custom-entity-view.png

@@ -19,7 +19,7 @@ To install or update a static plugin you must update your {product-very-short} a
 
 To install or update a dynamic plugin, you must restart your {product-very-short} application source code after installing the plugin.
 
-You can also import your own custom-built or third-party plugins or create new features using dynamic plugins.
+You can also import your own custom-built or {plugin-type-name} plugins or create new features using dynamic plugins.
 
 
 Dynamic plugins boost modularity and scalability by enabling more flexible and efficient functionality loading, significantly enhancing the developer experience and customization of your {product-very-short} instance.