RHIDP-8634-3 - [feedback] Improve the documentation to help developers convert plugins to dynamic plugins (#1534)

Gerry-Forde · web-flow · commit ffbc71df517a · 2025-11-10T22:29:00.000Z
* RHIDP-8634-3 - [feedback] Improve the documentation to help developers convert plugins to dynamic plugins

* RHIDP-8634-3 - [feedback] Improve the documentation to help developers convert plugins to dynamic plugins

* Update modules/dynamic-plugins/proc-custom-plugin-add-to-rhdh.adoc

* Update modules/dynamic-plugins/proc-custom-plugin-add-to-rhdh.adoc

* Update proc-custom-plugin-add-to-rhdh.adoc
diff --git a/modules/dynamic-plugins/proc-custom-plugin-add-to-rhdh.adoc b/modules/dynamic-plugins/proc-custom-plugin-add-to-rhdh.adoc
@@ -18,5 +18,7 @@ plugins:
 
 [NOTE]
 ====
-Ensure that your container images are publicly accessible, or that you have configured a pull secret in your environment. A pull secret provides {product} with credentials to authenticate pulling your plugin container images from a container registry.
-====
+Ensure that your container images are publicly accessible, or that you have configured a pull secret in your environment. A pull secret provides {product} with credentials to authenticate pulling your plugin container images from a container registry. 
+====
+
+//For more information about using image pull secrets on {platform-generic}, see https://docs.okd.io/latest/openshift_images/managing_images/using-image-pull-secrets.html
diff --git a/modules/dynamic-plugins/proc-custom-plugin-conversion.adoc b/modules/dynamic-plugins/proc-custom-plugin-conversion.adoc
@@ -53,7 +53,7 @@ yarn build:all
 +
 [NOTE]
 ====
-At this point, with {product-custom-resource-type}, you need to publish the built plugins to a NPM or NPM-compatible registry. However, as you are building this plugin to support it being loaded dynamically by {product}, you do not need to publish the plugin to a NPM registry. Instead, you can package the plugin for dynamic loading and publish it as a container image on `Quay.io` or your preferred container registry.
+After this step, with upstream {backstage}, you publish the built plugins to a NPM or NPM-compatible registry. In this example, as you are building this plugin to support it being loaded dynamically by {product}, you can skip the `npm publish` step that publishes the plugin to a NPM registry. Instead, you can package the plugin for dynamic loading and publish it as a container image on `Quay.io` or your preferred container registry.
 ====
 
 . Prepare the *Entity Feedback* frontend plugin by using the {product} CLI. The following command uses the plugin files in the `dist` folder that was generated by the `yarn build:all` command, and creates a new `dist-scalprum` folder that contains the necessary configuration and source files to enable dynamic loading:

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ yarn build:all`
`53`	`53`	`+`
`54`	`54`	`[NOTE]`
`55`	`55`	`====`
`56`		-At this point, with {product-custom-resource-type}, you need to publish the built plugins to a NPM or NPM-compatible registry. However, as you are building this plugin to support it being loaded dynamically by {product}, you do not need to publish the plugin to a NPM registry. Instead, you can package the plugin for dynamic loading and publish it as a container image on `Quay.io` or your preferred container registry.
	`56`	+After this step, with upstream {backstage}, you publish the built plugins to a NPM or NPM-compatible registry. In this example, as you are building this plugin to support it being loaded dynamically by {product}, you can skip the `npm publish` step that publishes the plugin to a NPM registry. Instead, you can package the plugin for dynamic loading and publish it as a container image on `Quay.io` or your preferred container registry.
`57`	`57`	`====`
`58`	`58`
`59`	`59`	. Prepare the Entity Feedback frontend plugin by using the {product} CLI. The following command uses the plugin files in the `dist` folder that was generated by the `yarn build:all` command, and creates a new `dist-scalprum` folder that contains the necessary configuration and source files to enable dynamic loading: