Skip to content

Commit 442893e

Browse files
committed
RHIDP-5422: Add conceptual info about how add-ons are imported, enabled, and added via the techdocs plugin package
1 parent d273d42 commit 442893e

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

assemblies/assembly-techdocs-addons-installing.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
33
[id="techdocs-addon-installing"]
44
= Installing and configuring a TechDocs add-on
55

6-
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.
7-
8-
The `<ReportIssue />` add-on is preinstalled in your {product} instance and enabled by default. Like any other supported dynamic plugin, you can install external TechDocs add-ons by using either the Operator or Helm chart. Additionally, you can import compatible third-party add-ons, including add-ons that you create yourself, the same way that you import any other third-party dynamic plugin into {product}.
6+
TechDocs add-ons are supported by {company-name} are imported by the `backstage-plugin-techdocs-module-addons-contrib` plugin package. The `<ReportIssue />` add-on is preinstalled in the TechDocs plugin and enabled by default. You can install external TechDocs add-ons by adding them to `backstage-plugin-techdocs-module-addons-contrib` package with either the {product} Operator or Helm chart. Additionally, you can import compatible third-party add-ons, including add-ons that you create yourself, with a third-party dynamic plugin.
97

108
include::modules/techdocs/proc-techdocs-addon-install-operator.adoc[]
119

assemblies/assembly-techdocs-addons.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,5 @@ The following table describes the TechDocs add-ons that are available for {produ
3030
//future release | `backstage-plugin-techdocs-module-addons-contrib`
3131
//future release | Expand or collapse the subtitles in the TechDocs navigation menu and keep your preferred state between documentation sites.
3232
|===
33+
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.

0 commit comments

Comments
 (0)