Skip to content

Commit 9c936cd

Browse files
authored
use @red-hat-developer-hub/cli instead of @janus-idp/cli (#1258)
1 parent c8c5cd3 commit 9c936cd

6 files changed

+14
-14
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,6 @@ You can add the following to your `package.json` file before running the `export
3434
}
3535
----
3636
37-
If you modify `publishConfig` after exporting the dynamic plugin, re-run the `export-dynamic-plugin` command to ensure the correct configuration is included.
37+
If you modify `publishConfig` after exporting the dynamic plugin, re-run the `plugin export` command to ensure the correct configuration is included.
3838
====
3939
--

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
.Example command to package an exported third-party plugin
1414
[source,terminal]
1515
----
16-
npx @janus-idp/cli@latest package package-dynamic-plugins --tag quay.io/example/image:v0.0.1
16+
npx @red-hat-developer-hub/cli@latest plugin package --tag quay.io/example/image:v0.0.1
1717
----
1818

1919
In the previous command, the `--tag` argument specifies the image name and tag.

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
To use plugins in {product}, you can export plugins as derived dynamic plugin packages. These packages contain the plugin code and dependencies, ready for dynamic plugin integration into {product-short}.
55

66
.Prerequisites
7-
* The `@janus-idp/cli` package is installed. Use the latest version (`@latest` tag) for compatibility with the most recent features and fixes.
7+
* The `@red-hat-developer-hub/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.
99
* 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].
1010
* The third-party plugin must have a valid `package.json` file in its root directory, containing all required metadata and dependencies.
@@ -35,7 +35,7 @@ The following is an example of exporting a dynamic plugin with shared and embedd
3535
.Example dynamic plugin export with shared and embedded packages
3636
[source,terminal]
3737
----
38-
npx @janus-idp/cli@latest export-dynamic-plugin --shared-package '!/@backstage/plugin-notifications/' --embed-package @backstage/plugin-notifications-backend
38+
npx @red-hat-developer-hub/cli@latest plugin export --shared-package '!/@backstage/plugin-notifications/' --embed-package @backstage/plugin-notifications-backend
3939
----
4040
+
4141
In the previous example:
@@ -51,7 +51,7 @@ Front-end plugins can use `scalprum` for configuration, which the CLI can genera
5151
.Example command to log the default configuration
5252
[source,terminal]
5353
----
54-
npx @janus-idp/cli@latest export-dynamic
54+
npx @red-hat-developer-hub/cli@latest plugin export
5555
----
5656
+
5757
The following is an example of default `scalprum` configuration:
@@ -105,13 +105,13 @@ export const DynamicEntityTechdocsContent = {
105105
--
106106

107107
.Procedure
108-
* Use the `package export-dynamic-plugin` command from the `@janus-idp/cli` package to export the plugin:
108+
* Use the `plugin export` command from the `@red-hat-developer-hub/cli` package to export the plugin:
109109
+
110110
--
111111
.Example command to export a third-party plugin
112112
[source,terminal]
113113
----
114-
npx @janus-idp/cli@latest package export-dynamic-plugin
114+
npx @red-hat-developer-hub/cli@latest plugin export
115115
----
116116

117117
Ensure that you execute the previous command in the root directory of the plugin's JavaScript package (containing `package.json` file).

modules/dynamic-plugins/ref-example-third-party-plugin-installation.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ $ yarn install
2222
[source,terminal]
2323
----
2424
$ cd todo-backend
25-
$ npx @janus-idp/cli@latest package export-dynamic-plugin
25+
$ npx @red-hat-developer-hub/cli@latest plugin export
2626
----
2727

2828
.Output of exporting the backend plugin commands
@@ -54,7 +54,7 @@ You can run the following commands to set default dynamic UI configurations, cre
5454
[source,terminal]
5555
----
5656
$ cd ../todo
57-
$ npx @janus-idp/cli@latest package export-dynamic-plugin
57+
$ npx @red-hat-developer-hub/cli@latest plugin export
5858
----
5959

6060
.Output of exporting the front-end plugin commands
@@ -87,7 +87,7 @@ Saving self-contained config schema in /Users/user/Code/community-plugins/worksp
8787
[source,terminal]
8888
----
8989
$ cd ../..
90-
$ npx @janus-idp/cli@latest package package-dynamic-plugins --tag quay.io/user/backstage-community-plugin-todo:v0.1.1
90+
$ npx @red-hat-developer-hub/cli@latest plugin package --tag quay.io/user/backstage-community-plugin-todo:v0.1.1
9191
----
9292

9393
.Output of building an OCI image commands

modules/proc-create-plugin.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The previous command creates a new plugin based on the provided ID. The plugin i
3232
yarn workspace {pluginID} start # Also supports --check <1>
3333
----
3434

35-
<1> ID of the new plugin such as `@janus-idp/my-new-plugin`
35+
<1> ID of the new plugin such as `@red-hat-developer-hub/my-new-plugin`
3636

3737
Accessing the plugin in isolation results in quicker iteration and startup times. This approach is specifically for local development, and you can find the necessary configuration in the plugin's `dev/` directory.
3838
--

modules/techdocs/proc-techdocs-addon-install-third-party.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,18 @@ yarn install
2626
+
2727
[source,terminal,subs="+quotes,+attributes"]
2828
----
29-
npx @janus-idp/cli@latest package export-dynamic-plugin
29+
npx @red-hat-developer-hub/cli@latest plugin export
3030
----
3131
+
3232
[NOTE]
3333
====
34-
The `@latest` tag pulls the latest version of the @janus-idp/cli package, which is compatible with the most recent features and fixes. Use a version that is compatible with your {product} version.
34+
The `@latest` tag pulls the latest version of the @red-hat-developer-hub/cli package, which is compatible with the most recent features and fixes. Use a version that is compatible with your {product} version.
3535
====
3636
. To package the third-party TechDocs add-on as a dynamic plugin, navigate to the root directory where the plugin is stored (not the dist-dynamic directory) and run the `npx` command with the `--tag` option to specify the image name and tag. For example:
3737
+
3838
[source,terminal,subs="+quotes,+attributes"]
3939
----
40-
npx @janus-idp/cli@latest package package-dynamic-plugins --tag quay.io/_<user_name>_/_<techdocs_add-on_image>_:latest
40+
npx @red-hat-developer-hub/cli@latest plugin package --tag quay.io/_<user_name>_/_<techdocs_add-on_image>_:latest
4141
----
4242
+
4343
[NOTE]

0 commit comments

Comments
 (0)