Skip to content

Commit 561529b

Browse files
committed
RHIDP-5422: Apply SME comments
1 parent 9b5f2ca commit 561529b

File tree

4 files changed

+62
-20
lines changed

4 files changed

+62
-20
lines changed

assemblies/assembly-techdocs-addons.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The following table describes the TechDocs add-ons that are available for {produ
1313

1414
| `<ReportIssue />`
1515
| `backstage-plugin-techdocs-module-addons-contrib`
16-
| Select a portion of text on a TechDocs page and open an issue against the repository that contains the documentation, populating the issue description with the selected text according to a configurable template.
16+
| Select a portion of text on a TechDocs page and open an issue against the repository that contains the documentation. The issue template is automatically populated with the selected text.
1717
| Preinstalled
1818

1919
| `<TextSize />`

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

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,17 @@ You can install compatible third-party TechDocs add-on on your {product} instanc
1111
.Prerequisites
1212
* The third-party TechDocs add-on has a valid `package.json` file in its root directory, containing all required metadata and dependencies.
1313
* You have installed the @janus-idp/cli package.
14+
* You have installed the `yarn` package manager.
1415
* You have installed and configured Node.js and NPM.
1516
* You have installed the `scalprum` CLI tool for configuring front-end plugins.
1617
1718
.Procedure
19+
. Install the third-party plugin that you want to use to import your third-party add-on by entering the following command:
20+
+
21+
[source,terminal,subs="+quotes,+attributes"]
22+
----
23+
yarn install
24+
----
1825
. Obtain the source code for the third-party TechDocs add-on that you want to use.
1926
. Export the TechDocs add-on as a dynamic plugin using the following command:
2027
+
@@ -27,21 +34,6 @@ npx @janus-idp/cli@latest package export-dynamic-plugin
2734
====
2835
The `@latest` tag uses the latest version of the `package.json` file for compatibility with the most recent features and fixes.
2936
====
30-
+
31-
.Example output
32-
[source,terminal,subs="+quotes,+attributes"]
33-
----
34-
Using scalpum config inlined in the `package.json`
35-
Packing main package to dist-dynamic/package.json
36-
Customizing main package in dist-dynamic/package.json for dynamic loading
37-
Generating dynamic frontend plugin assets in _<path_to_add-on_package>_/_<third-party_add-on_package>_/dist-dynamic/dist-scalprum
38-
...
39-
----
40-
+
41-
where
42-
43-
_<path_to_add-on_package>_ :: Specifies the package for the third-party add-on that you want to export, for example, `backstage-plugin-techdocs-module-addon-mermaid`.
44-
4537
. 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:
4638
+
4739
[source,terminal,subs="+quotes,+attributes"]

modules/techdocs/proc-techdocs-addon-remove-helm.adoc

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,32 @@
66
[id="proc-techdocs-addon-remove-helm_{context}"]
77
== Removing an external TechDocs add-on from your Helm chart
88

9-
If you no longer want to use the functionality of a TechDocs add-on that you installed on your {product} instance using the Helm chart, remove it from your Helm chart.
9+
If you no longer want to use the functionality of a TechDocs add-on that are imported from a particular plugin that you installed on your {product} instance with the Helm chart, you can temporarily disabled it or permanently remove it from your Helm chart. The `disabled` status is controlled at the plugin level, therefore, disabling the plugin disables all of the TechDocs add-ons in the disabled plugin package.
1010

1111
.Procedure
12-
* In the `techdocsAddons` section of the Helm chart, delete `importName: _<external_techdocs_add-on>` for each external TechDocs add-on that you want to remove. For example:
12+
* In the `plugins` section of the Helm chart, do one of the following actions based on whether you want to disable or remove a TechDocs add-on:
13+
** To temporarily disable all of the TechDocs add-ons in a particular plugin package, change the value of the `disabled` field to `true`. For example:
14+
+
15+
[source,yaml,subs="+quotes,+attributes"]
16+
----
17+
global:
18+
dynamic:
19+
plugins:
20+
- package: ./dynamic-plugins/dist/backstage-plugin-techdocs-module-addons-contrib
21+
disabled: true
22+
pluginConfig:
23+
dynamicPlugins:
24+
frontend:
25+
backstage.plugin-techdocs-module-addons-contrib:
26+
techdocsAddons:
27+
- importName: ReportIssue
28+
- importName: _<external_techdocs_add-on>_
29+
----
30+
+
31+
where:
32+
33+
_<external_techdocs_add-on>_:: Specifies the external TechDocs add-on that you want to remove, for example, `TextSize`.
34+
** To permanently remove one or more TechDocs add-ons from a plugin package, delete `importName: _<external_techdocs_add-on>` for each external TechDocs add-on that you want to remove. For example:
1335
+
1436
[source,yaml,subs="+quotes,+attributes"]
1537
----

modules/techdocs/proc-techdocs-addon-remove-operator.adoc

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,42 @@
66
[id="proc-techdocs-addon-remove-operator_{context}"]
77
== Removing an external TechDocs add-on from your ConfigMap
88

9-
If you no longer want to use the functionality of a TechDocs add-on that you installed on your {product} instance using the Operator, remove it from your ConfigMap.
9+
If you no longer want to use the functionality of a TechDocs add-on that are imported from a particular plugin that you installed on your {product} instance with the Operator, you can temporarily disabled it or permanently remove it from your ConfigMap. The `disabled` status is controlled at the plugin level, therefore, disabling the plugin disables all of the TechDocs add-ons in the disabled plugin package.
1010

1111
.Procedure
1212

1313
. From the Developer perspective in the {ocp-short} web console, click *ConfigMaps*.
1414
. From the *ConfigMaps* page, click the ConfigMap that contains the TechDocs add-on that you want to remove.
1515
. Select the *YAML view* option in the *Configure via* field.
16-
. In the `techdocsAddons` section of the ConfigMap, delete `importName: _<external_techdocs_add-on>` for each external TechDocs add-on that you want to remove. For example:
16+
. In the `plugins` section of the ConfigMap, do one of the following actions based on whether you want to disable or remove a TechDocs add-on:
17+
** To temporarily disable all of the TechDocs add-ons in a particular plugin package, change the value of the `disabled` field to `true`. For example:
18+
+
19+
[source,yaml,subs="+quotes,+attributes"]
20+
----
21+
kind: ConfigMap
22+
apiVersion: v1
23+
metadata:
24+
name: dynamic-plugins-rhdh
25+
data:
26+
dynamic-plugins.yaml: |
27+
includes:
28+
- dynamic-plugins.default.yaml
29+
plugins:
30+
- package: ./dynamic-plugins/dist/backstage-plugin-techdocs-module-addons-contrib
31+
disabled: true
32+
pluginConfig:
33+
dynamicPlugins:
34+
frontend:
35+
backstage.plugin-techdocs-module-addons-contrib:
36+
techdocsAddons:
37+
- importName: ReportIssue
38+
- importName: _<external_techdocs_add-on>_
39+
----
40+
+
41+
where:
42+
43+
_<external_techdocs_add-on>_:: Specifies the external TechDocs add-on that you want to remove, for example, `TextSize`.
44+
** To permanently remove one or more TechDocs add-ons from a plugin package, delete `importName: _<external_techdocs_add-on>` for each external TechDocs add-on that you want to remove. For example:
1745
+
1846
[source,yaml,subs="+quotes,+attributes"]
1947
----

0 commit comments

Comments
 (0)