RHIDP-8634-2-1-8 - Improve the documentation to help developers convert plugins to dynamic plugins CP #1514
Conversation
…rt plugins to dynamic plugins
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1514/ @ 11/06/25 12:40:13 |
|
Manual cherrypick of #1481 |
evanshortiss
left a comment
evanshortiss
left a comment
There was a problem hiding this comment.
Added some minor comments, though the git checkout and versioning is probably essential if we expect someone to follow and complete this. Looks good.
|
|
||
| //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] |
|
|
||
| [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. |
There was a problem hiding this comment.
I think npm should be lowercase - nodejs/nodejs.org#6917
| = Adding a custom dynamic plugin to {product} | ||
|
|
||
| .Procedure | ||
| . To add your custom dynamic plugins to {product}. you must update the `dynamic-plugins.yaml` file by using the following configuration that is generated from the `npx @red-hat-developer-hub/cli@latest plugin package` command: |
There was a problem hiding this comment.
I think this official doc might want to link to the specific instructions for "adding a plugin for helm installs" and the same for operators. Maybe I should add to the blog too
There was a problem hiding this comment.
Just in case someone is wondering where this file is, since it's not super clear. It's a file, but stored in a ConfigMap
|
|
||
| [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. |
There was a problem hiding this comment.
Suggest linking to pull secret guide in OCP docs or similar.
| * *Yarn:* Version 4.x | ||
| * *git CLI* | ||
| * *jq CLI:* Command-line JSON processor | ||
| * *OpenShift CLI (oc):* The client for interacting with your OpenShift cluster. |
There was a problem hiding this comment.
Where is the oc CLI used? I didn't see it
| * *git CLI* | ||
| * *jq CLI:* Command-line JSON processor | ||
| * *OpenShift CLI (oc):* The client for interacting with your OpenShift cluster. | ||
| * *Container runtime:* Either podman or docker is required for packaging the plugin into an OCI image and logging into registries. |
There was a problem hiding this comment.
I don't think container runtime is the correct term for this. "Container tooling" might be better
| [source,terminal] | ||
| ---- | ||
| git clone https://github.com/backstage/community-plugins.git | ||
| cd community-plugins |
There was a problem hiding this comment.
Is the git checkout command and text about versions not included for a reason?
| .`dynamic-plugins.yaml` file fragment | ||
| [source,yaml] | ||
| ---- | ||
| - package: oci://quay.io/_<user_name>_/entity-feedback-plugin:0.5.0!backstage-community-plugin-entity-feedback |
There was a problem hiding this comment.
The version 0.5.0 will be incorrect without the git checkout I referred to in another comment
3 participants
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
** This is a manual cherry pick of #1481
Version(s):
release-1.8
Issue:
RHIDP-8634
Preview: