Skip to content

Commit ba0995a

Browse files
committed
RHIDP-5422: Add more conceptual info about preinstalled and external add-ons and how they are imported by using dynamic plugins
1 parent e3cc777 commit ba0995a

File tree

3 files changed

+8
-19
lines changed

3 files changed

+8
-19
lines changed

assemblies/assembly-techdocs-addons.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ The following table describes the TechDocs add-ons that are available for {produ
3131
//future release | Expand or collapse the subtitles in the TechDocs navigation menu and keep your preferred state between documentation sites.
3232
|===
3333

34-
You can use a dynamic plugin to import a TechDocs add-on. TechDocs add-ons are enabled at the plugin level, therefore, enabling a plugin enables all of the TechDocs add-ons in the specified plugin package. The preinstalled and external add-ons supported by {company} are imported by the `backstage-plugin-techdocs-module-addons-contrib` plugin package. Since the `disabled` status is set at the plugin level, the `disabled` status of the plugin package applies to all of the TechDocs add-ons imported by that that package.
34+
You can use a dynamic plugin to import a TechDocs add-on. TechDocs add-ons are enabled at the plugin level, therefore, enabling a plugin enables all of the TechDocs add-ons in the specified plugin package. The preinstalled and external add-ons supported by {company} are imported by the `backstage-plugin-techdocs-module-addons-contrib` plugin package. Since the `disabled` status is set at the plugin level, the `disabled` status of the plugin package applies to all of the TechDocs add-ons imported by that package.

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

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66
[id="proc-techdocs-addon-install-helm_{context}"]
77
== Installing and configuring an external TechDocs add-on using the Helm chart
88

9-
You can use the {product} Helm chart to install a TechDocs add-on on your {product} instance as a dynamic plugin.
9+
You can use a dynamic plugin to import TechDocs add-ons into your TechDocs plugin. If you use the {product} Helm chart to install the dynamic plugin, you can add TechDocs add-ons to the plugin package in your Helm chart.
10+
11+
Preinstalled add-ons, such as `ReportIssue`, are included in the default `backstage-plugin-techdocs-module-addons-contrib` package configuration. External add-ons that are supported by {company-name} are installed by manually adding them to the `techdocsAddons` section of the configuration file.
1012

1113
.Prerequisites
1214
* The TechDocs plugin is installed and enabled.
@@ -34,13 +36,7 @@ global:
3436
techdocsAddons:
3537
- importName: ReportIssue
3638
----
37-
+
38-
[NOTE]
39-
====
40-
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.
41-
====
42-
43-
. 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:
39+
. 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:
4440
+
4541
[source,yaml,subs="+quotes,+attributes"]
4642
----

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

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,9 @@
66
[id="proc-techdocs-addon-install-operator_{context}"]
77
== Installing and configuring an external TechDocs add-on using the Operator
88

9-
You can use the {product} Operator to install a TechDocs add-on on your {product} instance as a dynamic plugin.
9+
You can use a dynamic plugin to import TechDocs add-ons into your TechDocs plugin. If you use the {product} Operator to install the dynamic plugin, you can add TechDocs add-ons to the plugin package in your ConfigMap.
1010

11-
.Prerequisites
12-
* An administrator has installed the {product} Operator.
13-
* The TechDocs plugin is installed and enabled.
11+
Preinstalled add-ons, such as `ReportIssue`, are included in the default `backstage-plugin-techdocs-module-addons-contrib` package configuration. External add-ons that are supported by {company-name} are installed by manually adding them to the `techdocsAddons` section of the configuration file.
1412

1513
.Procedure
1614

@@ -38,12 +36,7 @@ data:
3836
techdocsAddons:
3937
- importName: ReportIssue
4038
----
41-
+
42-
[NOTE]
43-
====
44-
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.
45-
====
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:
39+
. 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:
4740
+
4841
[source,yaml,subs="+quotes,+attributes"]
4942
----

0 commit comments

Comments
 (0)