Skip to content

Commit db75859

Browse files
Gerry-Fordejmagak
Gerry-Forde
and
jmagak
authored
RHIDP-8634-2 - Improve the documentation to help developers convert plugins to dynamic plugins (#1481)
* RHIDP-8634-2 - Improve the documentation to help developers convert plugins to dynamic plugins * RHIDP-8634-2 - Improve the documentation to help developers convert plugins to dynamic plugins * RHIDP-8634-2 - Improve the documentation to help developers convert plugins to dynamic plugins * RHIDP-8634-2 - Improve the documentation to help developers convert plugins to dynamic plugins * RHIDP-8634-2 - Improve the documentation to help developers convert plugins to dynamic plugins * RHIDP-8634-2 - Improve the documentation to help developers convert plugins to dynamic plugins * Update assemblies/dynamic-plugins/assembly-converting-custom-plugin-to-dynamic-plugin.adoc Co-authored-by: Judith Magak <[email protected]> * Update assemblies/dynamic-plugins/assembly-converting-custom-plugin-to-dynamic-plugin.adoc Co-authored-by: Judith Magak <[email protected]> * Update assemblies/dynamic-plugins/assembly-converting-custom-plugin-to-dynamic-plugin.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/con-custom-plugin-add-to-rhdh.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-custom-plugin-conversion.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-custom-plugin-conversion.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/con-custom-plugin-add-to-rhdh.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/con-custom-plugin-add-to-rhdh.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/con-custom-plugin-add-to-rhdh.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/con-custom-plugin-conversion.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/con-custom-plugin-conversion.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-custom-plugin-conversion.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-custom-plugin-conversion.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-custom-plugin-conversion.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-custom-plugin-conversion.adoc Co-authored-by: Judith Magak <[email protected]> * RHIDP-8634-2 - Improve the documentation to help developers convert plugins to dynamic plugins * RHIDP-8634-2 - Improve the documentation to help developers convert plugins to dynamic plugins * RHIDP-8634-2 - Improve the documentation to help developers convert plugins to dynamic plugins --------- Co-authored-by: Judith Magak <[email protected]>
1 parent bceea79 commit db75859

24 files changed

+302
-28
lines changed

‎artifacts/attributes.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,8 @@
168168
:upgrading-book-title: Upgrading {product}
169169
:using-dynamic-plugins-book-link: {product-docs-link}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
170170
:using-dynamic-plugins-book-title: Using dynamic plugins
171+
:plugin-type-name: custom
172+
:plugin-type-name-uppercase: Custom
171173

172174
:scorecard-plugin-book-link: {product-docs-link}/html-single/understand_and_visualize_red_hat_developer_hub_project_health_using_scorecards/index
173175
:scorecard-plugin-book-title: Understand and visualize {product} project health using Scorecards

‎assemblies/dynamic-plugins/assembly-converting-custom-plugin-to-dynamic-plugin.adoc‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
= Extending {product} with custom plugins
4+
5+
You can extend {product} with your own custom plugins. However, to add a custom plugin to the {product} pre-built container image, you must bundle and install your custom plugin as a dynamic plugin.
6+
7+
To integrate a custom plugin into {product-short}, complete the following steps:
8+
9+
. First, obtain the plugin's source code.
10+
. Export the plugin as a dynamic plugin package.
11+
. Package and publish the dynamic plugin.
12+
. Install the plugin in the {product-short} environment.
13+
14+
[NOTE]
15+
====
16+
Standard {product-custom-resource-type} deployments statically compile plugins into the application itself. {product} supports dynamic plugins, meaning you can add plugins to an existing instance without recompiling the underlying {product-custom-resource-type} application.
17+
====
18+
19+
include::../modules/dynamic-plugins/con-custom-plugin-conversion.adoc[leveloffset=+1]
20+
21+
include::../modules/dynamic-plugins/proc-custom-plugin-conversion.adoc[leveloffset=+1]
22+
23+
include::../modules/dynamic-plugins/con-custom-plugin-add-to-rhdh.adoc[leveloffset=+1]
24+

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
:_mod-docs-content-type: ASSEMBLY
22

33
[id="assembly-install-third-party-plugins-rhdh"]
4-
= Installing third-party plugins in {product}
4+
= Installing {plugin-type-name} plugins in {product}
55
:context: assembly-install-third-party-plugins-rhdh
66

7-
You can install a third-party plugins in {product} without rebuilding the {product-very-short} application.
7+
You can install a {plugin-type-name} plugins in {product} without rebuilding the {product-very-short} application.
88

99
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].
1010

@@ -30,5 +30,5 @@ include::../modules/dynamic-plugins/proc-load-plugin-tgz-file.adoc[leveloffset=+
3030
include::../modules/dynamic-plugins/proc-load-plugin-js-package.adoc[leveloffset=+2]
3131

3232
//example third-party plugin installation
33-
include::../modules/dynamic-plugins/proc-example-third-party-plugin-installation.adoc[leveloffset=+2]
33+
//include::../modules/dynamic-plugins/proc-example-third-party-plugin-installation.adoc[leveloffset=+2]
3434

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
:_mod-docs-content-type: ASSEMBLY
22

33
[id="assembly-package-publish-third-party-dynamic-plugin"]
4-
= Packaging and publishing third-party plugins as dynamic plugins
4+
= Packaging and publishing {plugin-type-name} plugins as dynamic plugins
55
:context: assembly-package-publish-third-party-dynamic-plugin
66

7-
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:
7+
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:
88

99
* Open Container Initiative (OCI) image (recommended)
1010
* TGZ file

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

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
:_mod-docs-content-type: ASSEMBLY
22

33
[id="assembly-third-party-plugins"]
4-
= Third-party plugins in {product}
4+
= {plugin-type-name-uppercase} plugins in {product}
55
:context: assembly-third-party-plugins
66

7-
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.
7+
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.
88

99
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.
1010

11-
To integrate a third-party plugin into {product-short}:
11+
To integrate a {plugin-type-name} plugin into {product-short}:
1212

1313
. First, obtain the plugin's source code.
1414
. 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
2424
//Install third-party plugin
2525
include::assembly-install-third-party-plugins-rhdh.adoc[leveloffset=+1]
2626

27+
include::../modules/dynamic-plugins/proc-custom-plugin-conversion.adoc[leveloffset=+1]
28+
29+
include::../modules/dynamic-plugins/proc-custom-plugin-add-to-rhdh.adoc[leveloffset=+2]
30+
31+
include::../modules/dynamic-plugins/proc-displaying-frontend-plugin.adoc[leveloffset=+2]
2732

2833

‎images/rhdh/custom-container-images.png‎

58.5 KB
Loading

‎images/rhdh/custom-entity-view.png‎

54.5 KB
Loading

‎images/rhdh/custom-extensions.png‎

50.7 KB
Loading

‎images/rhdh/custom-feedback-overlay.png‎

58.8 KB
Loading

‎images/rhdh/custom-limitations.png‎

64.3 KB
Loading

0 commit comments

Comments
 (0)