Skip to content

Commit 01a80c1

Browse files
committed
review suggestions incorporated
1 parent 3b37d79 commit 01a80c1

File tree

4 files changed

+11
-9
lines changed

4 files changed

+11
-9
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
You can install a third-party plugins in {product} without rebuilding the {product-very-short} application.
66

7-
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[] and xref:con-install-dynamic-plugin-helm_rhdh-installing-rhdh-plugins[].
7+
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].
88

99
Plugins are defined in the `plugins` array within the `dynamic-plugin-config.yaml` file. Each plugin is represented as an object with the following properties:
1010

@@ -15,7 +15,7 @@ Plugins are defined in the `plugins` array within the `dynamic-plugin-config.yam
1515

1616
[NOTE]
1717
====
18-
You can also load dynamic plugins from a plain directory, though this is intended for development or testing purposes and is not recommended for production, except for plugins included in the {product-very-short} container image.
18+
You can also load dynamic plugins from another directory, though this is intended for development or testing purposes and is not recommended for production, except for plugins included in the {product-very-short} container image.
1919
====
2020

2121
//OCI image

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ After xref:proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[exp
77
* Open Container Initiative (OCI) image (recommended)
88
* TGZ file
99
* JavaScript package
10-
10+
+
1111
[IMPORTANT]
1212
====
1313
Exported dynamic plugin packages must only be published to private NPM registries.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
= Third-party plugins in {product}
33
:context: assembly-third-party-plugins
44

5-
You can integrate third-party dynamic plugins in {product}. This flexibility allows you to enhance the platform functionality without modifying its source code and rebuilding. To add third-party dynamic plugins, you can export them as derived package.
5+
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.
66

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

modules/dynamic-plugins/proc-export-third-party-plugins-rhdh.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ To use plugins in {product}, you can export plugins as derived dynamic plugin pa
66
Backend plugins::
77
+
88
--
9-
To ensure compatibility with the dynamic plugin support and enable their use as dynamic plugins, existing backend plugins must be compatible with the new backend system. Additionally, these plugins must be rebuilt using a dedicated CLI command.
9+
To ensure compatibility with the dynamic plugin support and enable their use as dynamic plugins, existing backend plugins must be compatible with the backend system. Additionally, these plugins must be rebuilt using a dedicated CLI command.
1010

11-
The new backend system entry point (created using `createBackendPlugin()` or `createBackendModule()`) must be exported as the default export from either the main package or an `alpha` package (if the plugin instance support is still provided using `alpha` APIs). This doesn't add any additional requirement on top of the standard plugin development guidelines of the plugin instance.
11+
The backend system entry point (created using `createBackendPlugin()` or `createBackendModule()`) must be exported as the default export from either the main package or an `alpha` package (if the plugin instance support is still provided using `alpha` APIs). This doesn't add any additional requirement on top of the standard plugin development guidelines of the plugin instance.
1212

1313
The dynamic export mechanism identifies private dependencies and sets the `bundleDependencies` field in the `package.json` file. This export mechanism ensures that the dynamic plugin package is published as a self-contained package, with its private dependencies bundled in a private `node_modules` folder.
1414

@@ -29,7 +29,7 @@ The following is an example of exporting a dynamic plugin with shared and embedd
2929
.Example dynamic plugin export with shared and embedded packages
3030
[source,bash]
3131
----
32-
npx @janus-idp/cli@latest export-dynamic-plugin --shared-package '!/@backstage/plugin-notifications/'<1> --embed-package @backstage/plugin-notifications-backend <2>
32+
npx @janus-idp/cli@latest export-dynamic-plugin --shared-package '!/@backstage/plugin-notifications/' <1> --embed-package @backstage/plugin-notifications-backend <2>
3333
----
3434

3535
<1> `@backstage/plugin-notifications` package is treated as a private dependency and is bundled in the dynamic plugin package, despite being in the `@backstage` scope.
@@ -104,8 +104,9 @@ export const DynamicEntityTechdocsContent = {
104104
* The third-party plugin is compatible with your {product} version. For more information, see link:https://github.com/janus-idp/backstage-showcase/blob/main/docs/dynamic-plugins/versions.md[Version compatibility matrix].
105105

106106
.Procedure
107-
Use the `package export-dynamic-plugin` command from the `@janus-idp/cli` package to export the plugin:
108-
107+
* Use the `package export-dynamic-plugin` command from the `@janus-idp/cli` package to export the plugin:
108+
+
109+
--
109110
.Example command to export a third-party plugin
110111
[source,bash]
111112
----
@@ -120,5 +121,6 @@ The resulting derived package will be located in the `dist-dynamic` subfolder. T
120121
====
121122
The derived dynamic plugin JavaScript packages must not be published to the public NPM registry. For more appropriate packaging options, see xref:assembly-package-publish-third-party-dynamic-plugin[]. If you must publish to the NPM registry, use a private registry.
122123
====
124+
--
123125

124126

0 commit comments

Comments
 (0)