Skip to content

Commit 8a547fb

Browse files
author
GitHub Actions
committed
Move links in Prerequisites to Additional resources-Dynamic-plugins-and-importing-repositories
1 parent c12f7a6 commit 8a547fb

13 files changed

+81
-26
lines changed

modules/dynamic-plugins/proc-create-plugin-js-package.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The derived dynamic plugin JavaScript packages must not be published to the publ
77
====
88

99
.Prerequisites
10-
* You have exported a third-party dynamic plugin package. For more information, see xref:proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[].
10+
* You have exported a third-party dynamic plugin package.
1111

1212
.Procedure
1313
. Navigate to the `dist-dynamic` directory.
@@ -36,4 +36,9 @@ You can add the following to your `package.json` file before running the `export
3636
3737
If you modify `publishConfig` after exporting the dynamic plugin, re-run the `export-dynamic-plugin` command to ensure the correct configuration is included.
3838
====
39-
--
39+
--
40+
41+
[role="_additional-resources"]
42+
.Additional resources
43+
44+
* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.6/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index#proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[Exporting third-party plugins in {product}]

modules/dynamic-plugins/proc-create-plugin-oci-image.adoc

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

44
.Prerequisites
55
* You have installed `podman` or `docker`.
6-
* You have exported a third-party dynamic plugin package. For more information, see xref:proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[].
6+
* You have exported a third-party dynamic plugin package.
77

88
.Procedure
99
. Navigate to the plugin's root directory (not the `dist-dynamic` directory).
@@ -34,4 +34,9 @@ docker push quay.io/example/image:v0.0.1
3434
----
3535

3636
The output of the `package-dynamic-plugins` command provides the plugin's path for use in the `dynamic-plugin-config.yaml` file.
37-
--
37+
--
38+
39+
[role="_additional-resources"]
40+
.Additional resources
41+
42+
* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.6/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index#proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[Exporting third-party plugins in {product}]

modules/dynamic-plugins/proc-create-plugin-tgz-file.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
= Creating a TGZ file with dynamic packages
33

44
.Prerequisites
5-
* You have exported a third-party dynamic plugin package. For more information, see xref:proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[].
5+
* You have exported a third-party dynamic plugin package.
66

77
.Procedure
88
. Navigate to the `dist-dynamic` directory.
@@ -67,4 +67,9 @@ oc new-app --image-stream=plugin-registry
6767
plugins:
6868
- package: http://plugin-registry:8080/backstage-plugin-myplugin-1.9.6.tgz
6969
----
70-
--
70+
--
71+
72+
[role="_additional-resources"]
73+
.Additional resources
74+
75+
* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.6/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index#proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[Exporting third-party plugins in {product}]

modules/dynamic-plugins/proc-enable-plugins-rhdh-container-image.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ In the {product-very-short} container image, a set of dynamic plugins is preload
66
You can enable and configure the plugins in the {product-very-short} container image, including how to manage the default configuration, set necessary environment variables, and ensure the proper functionality of the plugins within your application.
77

88
.Prerequisites
9-
* You have access to the link:https://github.com/janus-idp/backstage-showcase/blob/main/dynamic-plugins.default.yaml[`dynamic-plugins.default.yaml`] file, which lists all preloaded plugins and their default configuration.
9+
* You have access to the `dynamic-plugins.default.yaml` file, which lists all preloaded plugins and their default configuration.
1010
* You have deployed the {product-very-short} application, and have access to the logs of the `install-dynamic-plugins` init container.
1111
* You have the necessary permissions to modify plugin configurations and access the application environment.
1212
* You have identified and set the required environment variables referenced by the plugin's default configuration. These environment variables must be defined in the Helm Chart or Operator configuration.
@@ -34,3 +34,8 @@ For more information about how to configure dynamic plugins in {product-short},
3434
.Verification
3535
. Restart the {product-very-short} application and verify that the plugin is successfully activated and configured.
3636
. Verify the application logs for confirmation and ensure the plugin is functioning as expected.
37+
38+
[role="_additional-resources"]
39+
.Additional resources
40+
41+
* link:https://github.com/janus-idp/backstage-showcase/blob/main/dynamic-plugins.default.yaml[`dynamic-plugins.default.yaml` file]

modules/dynamic-plugins/proc-enable-users-to-use-topology-plugin.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The Topology plugin is defining additional permissions. When link:{authorization
88
* The `catalog-entity` `read` permission to view the {product} software catalog items.
99

1010
.Prerequisites
11-
* You are link:{authorization-book-url}#managing-authorizations-by-using-external-files[managing {authorization-book-title} by using external files].
11+
* You are managing {authorization-book-title} by using external files.
1212

1313
.Procedure
1414
* Add the following permission policies to your `rbac-policy.csv` file to create a `topology-viewer` role that has access to the Topology plugin features, and add the role to the users requiring this authorization:
@@ -23,4 +23,9 @@ p, role:default/topology-viewer, catalog-entity, read, allow <3>
2323
----
2424
<1> Grants the user the ability to see the Topology panel.
2525
<2> Grants the user the ability to view the pod logs.
26-
<3> Grants the user the ability to see the catalog item.
26+
<3> Grants the user the ability to see the catalog item.
27+
28+
[role="_additional-resources"]
29+
.Additional resources
30+
31+
* link:{authorization-book-url}#managing-authorizations-by-using-external-files[Managing {authorization-book-title} by using external files]

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ To use plugins in {product}, you can export plugins as derived dynamic plugin pa
66
.Prerequisites
77
* The `@janus-idp/cli` package is installed. Use the latest version (`@latest` tag) for compatibility with the most recent features and fixes.
88
* Node.js and NPM is installed and configured.
9-
* The third-party plugin is compatible with your {product} version. For more information, see link:https://github.com/redhat-developer/rhdh/blob/main/docs/dynamic-plugins/versions.md[Version compatibility matrix].
9+
* The third-party plugin is compatible with your {product} version. For more information, see the Version compatibility matrix.
1010
* The third-party plugin must have a valid `package.json` file in its root directory, containing all required metadata and dependencies.
1111
+
1212
--
@@ -124,4 +124,7 @@ The derived dynamic plugin JavaScript packages must not be published to the publ
124124
====
125125
--
126126

127+
[role="_additional-resources"]
128+
.Additional resources
127129

130+
* link:https://github.com/redhat-developer/rhdh/blob/main/docs/dynamic-plugins/versions.md[Version compatibility matrix]

modules/dynamic-plugins/proc-load-plugin-js-package.adoc

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22
= Loading a plugin packaged as a JavaScript package
33

44
.Prerequisites
5-
* The third-party plugin is packaged as a dynamic plugin in a JavaScript package.
6-
+
7-
For more information about packaging a third-party plugin, see xref:assembly-package-publish-third-party-dynamic-plugin[].
5+
* The third-party plugin is packaged as a dynamic plugin in a JavaScript package.
86

97
.Procedure
108
. Run the following command to obtain the integrity hash from the NPM registry:
@@ -65,4 +63,9 @@ stringData:
6563
`_<release_name>_-dynamic-plugins-npmrc`
6664
--
6765

68-
. To apply the changes, restart the {product-very-short} application.
66+
. To apply the changes, restart the {product-very-short} application.
67+
68+
[role="_additional-resources"]
69+
.Additional resources
70+
71+
* xref:assembly-package-publish-third-party-dynamic-plugin[Packaging a third-party plugin]

modules/dynamic-plugins/proc-load-plugin-oci-image.adoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22
= Loading a plugin packaged as an OCI image
33

44
.Prerequisites
5-
* The third-party plugin is packaged as a dynamic plugin in an OCI image.
6-
+
7-
For more information about packaging a third-party plugin, see xref:assembly-package-publish-third-party-dynamic-plugin[].
5+
* The third-party plugin is packaged as a dynamic plugin in an OCI image.
86

97
.Procedure
108
. To retrieve plugins from an authenticated registry, complete the following steps:
@@ -55,3 +53,8 @@ plugins:
5553
----
5654
--
5755
. To apply the changes, restart the {product-very-short} application.
56+
57+
[role="_additional-resources"]
58+
.Additional resources
59+
60+
* xref:assembly-package-publish-third-party-dynamic-plugin[Packaging a third-party plugin]

modules/dynamic-plugins/proc-load-plugin-tgz-file.adoc

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22
= Loading a plugin packaged as a TGZ file
33

44
.Prerequisites
5-
* The third-party plugin is packaged as a dynamic plugin in a TGZ file.
6-
+
7-
For more information about packaging a third-party plugin, see xref:assembly-package-publish-third-party-dynamic-plugin[].
5+
* The third-party plugin is packaged as a dynamic plugin in a TGZ file.
86

97
.Procedure
108

@@ -21,4 +19,9 @@ plugins:
2119
----
2220
--
2321

24-
. To apply the changes, restart the {product-very-short} application.
22+
. To apply the changes, restart the {product-very-short} application.
23+
24+
[role="_additional-resources"]
25+
.Additional resources
26+
27+
* xref:assembly-package-publish-third-party-dynamic-plugin[Packaging a third-party plugin]

modules/dynamic-plugins/proc-using-topology-plugin.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33

44
.Prerequisites
55
* Your {product} instance is installed and running.
6-
* You have installed the Topology plugin.
6+
* You have installed the Topology plugin.
77
//For the installation process, see Installation.
8-
* You have xref:enable-users-to-use-the-topology-plugin[enabled the users to use the Topology plugin].
8+
* You have enabled the users to use the Topology plugin.
99

1010
.Procedure
1111

@@ -25,3 +25,8 @@ image::rhdh-plugins-reference/topology-tab-user2.png[topology-user-2]
2525
image::rhdh-plugins-reference/topology-tab-user3.png[topology-user-3]
2626
+
2727
Click the *Open URL* button to access the associated *Ingresses* and run your application in a new tab.
28+
29+
[role="_additional-resources"]
30+
.Additional resources
31+
32+
* xref:enable-users-to-use-the-topology-plugin[Enabling the users to use the Topology plugin]

0 commit comments

Comments
 (0)