Skip to content

Commit 4eb8820

Browse files
committed
RHIDP-5422: Apply add'l SME comments
1 parent 561529b commit 4eb8820

6 files changed

+13
-16
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ global:
3737
Preinstalled add-ons, such as `ReportIssue`, are included in the default package configuration. Additional add-ons are installed by manually adding them to the configuration file.
3838
====
3939

40-
. In the `techdocsAddons` section of the Helm chart, add `importName: _<external_techdocs_add-on>` for each external TechDocs add-on that you want to install. For example:
40+
. In the `techdocsAddons` section of the Helm chart, add `importName: _<external_techdocs_add-on>` for each external TechDocs add-on that you want to add from the specified plugin package. For example:
4141
+
4242
[source,yaml,subs="+quotes,+attributes"]
4343
----

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ data:
4343
====
4444
Preinstalled add-ons, such as `ReportIssue`, are included in the default package configuration. Additional add-ons are installed by manually adding them to the configuration file.
4545
====
46-
. In the `techdocsAddons` section of the ConfigMap, add `importName: _<external_techdocs_add-on>` for each external TechDocs add-on that you want to install. For example:
46+
. In the `techdocsAddons` section of the ConfigMap, add `importName: _<external_techdocs_add-on>` for each external TechDocs add-on that you want to add from the specified plugin package. For example:
4747
+
4848
[source,yaml,subs="+quotes,+attributes"]
4949
----

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

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ You can install compatible third-party TechDocs add-on on your {product} instanc
1313
* You have installed the @janus-idp/cli package.
1414
* You have installed the `yarn` package manager.
1515
* You have installed and configured Node.js and NPM.
16-
* You have installed the `scalprum` CLI tool for configuring front-end plugins.
1716
1817
.Procedure
1918
. Install the third-party plugin that you want to use to import your third-party add-on by entering the following command:
@@ -32,7 +31,7 @@ npx @janus-idp/cli@latest package export-dynamic-plugin
3231
+
3332
[NOTE]
3433
====
35-
The `@latest` tag uses the latest version of the `package.json` file for compatibility with the most recent features and fixes.
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.
3635
====
3736
. 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:
3837
+
@@ -73,17 +72,15 @@ plugins:
7372
techdocsAddons:
7473
- importName: _<third-party_add-on_name>_
7574
config:
76-
props:
77-
config:
78-
theme: _<theme_name>_
79-
themeVariables: { lineColor: "_<line_color_variable>_"}
75+
props:
76+
_<techdocs_add-on_property_key>_: _<techdocs_add-on_property_value>_
8077
----
8178
+
8279
where
8380
84-
_<user_name>>_ :: Specifies your Quay user name or organization name.
81+
_<user_name>_ :: Specifies your Quay user name or organization name.
8582
_<techdocs_add-on_image>_ :: Specifies the name of the image for the third-party add-on that you want to use, for example, `mermaid`.
8683
_<techdocs_add-on_package>_ :: Specifies the , for example, `backstage-plugin-techdocs-addon-mermaid`.
8784
_<third-party_add-on_name>_ :: Specifies the name of the third-party add-on that you want to use, for example, `Mermaid`.
88-
_<theme_name>_ :: Specifies the name of the visual theme that you want to apply to your third-party TechDocs add-on, for example, `forest`. Depending on the third-party add-on, this field can be optional or required.
89-
_<line_color_variable>_ :: Specifies the line color that you want to use in the visual theme, for example, #000000. Depending on the third-party add-on, this field can be optional or required.
85+
_<techdocs_add-on_property_key>_ :: Specifies the name of the custom property that can be passed to the third-party add-on, for example, `themeVariables`. Properties are specific to each add-on. You can list multiple properties for an add-on.
86+
_<techdocs_add-on_property_value>_ :: Specifies the value of a property key for the third-party add-on, for example, `lineColor: #000000`.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
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 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.
9+
If you no longer want to use the functionality of a TechDocs add-on that is imported from a particular plugin that you installed on your {product} instance with the Helm chart, you can temporarily disable 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
1212
* 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:
@@ -31,7 +31,7 @@ global:
3131
where:
3232
3333
_<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:
34+
** To remove one or more TechDocs add-ons from your {product} instance, delete `importName: _<external_techdocs_add-on>_` for each external TechDocs add-on that you want to remove from the `techdocsAddons` section of your Helm chart. For example:
3535
+
3636
[source,yaml,subs="+quotes,+attributes"]
3737
----

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
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 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.
9+
If you no longer want to use the functionality of a TechDocs add-on that is imported from a particular plugin that you installed on your {product} instance with the Operator, you can temporarily disable 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

@@ -41,7 +41,7 @@ data:
4141
where:
4242

4343
_<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:
44+
** To remove one or more TechDocs add-ons from your {product} instance, delete `importName: _<external_techdocs_add-on>_` for each external TechDocs add-on that you want to remove from the `techdocsAddons` section of your ConfigMap. For example:
4545
+
4646
[source,yaml,subs="+quotes,+attributes"]
4747
----

modules/techdocs/proc-techdocs-addon-use-report-issue.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ If you find an error in your organization's TechDocs documentation, you can use
1010

1111
.Prerequisites
1212
* The `ReportIssue` add-on is installed and enabled in your TechDocs plugin.
13-
* You have permissions to write to the repository where documentation issues are reported.
13+
* You have permissions to create issues in the repository where documentation issues are reported.
1414
1515
.Procedure
1616
. In your TechDocs documentation, highlight the text that you want to report an issue for.

0 commit comments

Comments
 (0)