Skip to content

Commit 6ea545c

Browse files
hmanwani-rhopenshift-cherrypick-robot
authored andcommitted
review suggestions incorporated
1 parent 172f54e commit 6ea545c

6 files changed

+21
-21
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
@@ -15,7 +15,7 @@ The derived dynamic plugin JavaScript packages must not be published to the publ
1515
+
1616
--
1717
.Example command to publish a plugin package to an NPM registry
18-
[source,bash]
18+
[source,terminal]
1919
----
2020
npm publish --registry <npm_registry_url>
2121
----

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
+
1212
--
1313
.Example command to package an exported third-party plugin
14-
[source,bash]
14+
[source,terminal]
1515
----
1616
npx @janus-idp/cli@latest package package-dynamic-plugins --tag quay.io/example/image:v0.0.1
1717
----
@@ -22,13 +22,13 @@ In the previous command, the `--tag` argument specifies the image name and tag.
2222
+
2323
--
2424
.Example command to push an image to a registry using podman
25-
[source,bash]
25+
[source,terminal]
2626
----
2727
podman push quay.io/example/image:v0.0.1
2828
----
2929

3030
.Example command to push an image to a registry using docker
31-
[source,bash]
31+
[source,terminal]
3232
----
3333
docker push quay.io/example/image:v0.0.1
3434
----

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@
1010
+
1111
--
1212
.Example command to create a `tgz` archive
13-
[source,bash]
13+
[source,terminal]
1414
----
1515
npm pack
1616
----
1717
You can obtain the integrity hash from the output of the `npm pack` command by using the `--json` flag as follows:
1818

1919
.Example command to obtain the integrity hash of a `tgz` archive
20-
[source,bash]
20+
[source,terminal]
2121
----
2222
npm pack --json | head -n 10
2323
----
@@ -38,7 +38,7 @@ plugins:
3838
+
3939
--
4040
.Example command to package a dynamic plugin
41-
[source,bash]
41+
[source,terminal]
4242
----
4343
npm pack --pack-destination ~/test/dynamic-plugins-root/
4444
----
@@ -48,7 +48,7 @@ npm pack --pack-destination ~/test/dynamic-plugins-root/
4848
To create a plugin registry using HTTP server on {ocp-short}, run the following commands:
4949
5050
.Example commands to build and deploy an HTTP server in {ocp-short}
51-
[source,bash]
51+
[source,terminal]
5252
----
5353
oc project rhdh
5454
oc new-build httpd --name=plugin-registry --binary

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ You can use the `--embed-package` flag to specify additional embedded packages.
3333
The following is an example of exporting a dynamic plugin with shared and embedded packages:
3434
+
3535
.Example dynamic plugin export with shared and embedded packages
36-
[source,bash]
36+
[source,terminal]
3737
----
3838
npx @janus-idp/cli@latest export-dynamic-plugin --shared-package '!/@backstage/plugin-notifications/' <1> --embed-package @backstage/plugin-notifications-backend <2>
3939
----
@@ -46,7 +46,7 @@ Front-end plugins::
4646
Front-end plugins can use `scalprum` for configuration, which the CLI can generate automatically during the export process. The generated default configuration is logged when running the following command:
4747
+
4848
.Example command to log the default configuration
49-
[source,bash]
49+
[source,terminal]
5050
----
5151
npx @janus-idp/cli@latest export-dynamic
5252
----
@@ -106,7 +106,7 @@ export const DynamicEntityTechdocsContent = {
106106
+
107107
--
108108
.Example command to export a third-party plugin
109-
[source,bash]
109+
[source,terminal]
110110
----
111111
npx @janus-idp/cli@latest package export-dynamic-plugin
112112
----

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ For more information about packaging a third-party plugin, see xref:assembly-pac
1010
. Run the following command to obtain the integrity hash from the NPM registry:
1111
+
1212
--
13-
[source,bash]
13+
[source,terminal]
1414
----
1515
npm view --registry <registry-url> <npm package>@<version> dist.integrity
1616
----

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This section describes the process for integrating the link:https://github.com/b
77
+
88
--
99
.Obtain the third-party plugin source code
10-
[source,bash]
10+
[source,terminal]
1111
----
1212
$ git clone https://github.com/backstage/community-plugins
1313
$ cd community-plugins/workspaces/todo
@@ -19,14 +19,14 @@ $ yarn install
1919
+
2020
--
2121
.Export the backend plugin
22-
[source,bash]
22+
[source,terminal]
2323
----
2424
$ cd todo-backend
2525
$ npx @janus-idp/cli@latest package export-dynamic-plugin
2626
----
2727

2828
.Output of exporting the backend plugin commands
29-
[source,bash]
29+
[source,terminal]
3030
----
3131
Building main package
3232
executing yarn build ✔
@@ -51,14 +51,14 @@ Saving self-contained config schema in /Users/user/Code/community-plugins/worksp
5151
You can run the following commands to set default dynamic UI configurations, create front-end plugin assets, and to generate a configuration schema for a front-end plugin:
5252

5353
.Export the front-end plugin
54-
[source,bash]
54+
[source,terminal]
5555
----
5656
$ cd ../todo
5757
$ npx @janus-idp/cli@latest package export-dynamic-plugin
5858
----
5959

6060
.Output of exporting the front-end plugin commands
61-
[source,bash]
61+
[source,terminal]
6262
----
6363
No scalprum config. Using default dynamic UI configuration:
6464
{
@@ -84,14 +84,14 @@ Saving self-contained config schema in /Users/user/Code/community-plugins/worksp
8484
+
8585
--
8686
.Build an OCI image
87-
[source,bash]
87+
[source,terminal]
8888
----
8989
$ cd ../..
9090
$ npx @janus-idp/cli@latest package package-dynamic-plugins --tag quay.io/user/backstage-community-plugin-todo:v0.1.1
9191
----
9292

9393
.Output of building an OCI image commands
94-
[source,bash]
94+
[source,terminal]
9595
----
9696
executing podman --version ✔
9797
Using existing 'dist-dynamic' directory at plugins/todo
@@ -120,13 +120,13 @@ plugins:
120120
----
121121

122122
.Push the OCI image to a container registry:
123-
[source,bash]
123+
[source,terminal]
124124
----
125125
$ podman push quay.io/user/backstage-community-plugin-todo:v0.1.1
126126
----
127127

128128
.Output of pushing the OCI image command
129-
[source,bash]
129+
[source,terminal]
130130
----
131131
Getting image source signatures
132132
Copying blob sha256:86a372c456ae6a7a305cd464d194aaf03660932efd53691998ab3403f87cacb5

0 commit comments

Comments
 (0)