Skip to content

Commit f06ebe6

Browse files
authored
RHIDP-6667: Update TechDocs add-ons doc (redhat-developer#1026)
* RHIDP-6667: Update TechDocs add-ons doc * RHIDP-6667: Apply PR comments
1 parent 8bb50e4 commit f06ebe6

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

assemblies/assembly-techdocs-addons-installing.adoc

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

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.
6+
TechDocs add-ons supported by {company-name} are exported to the TechDocs plugin by the`backstage-plugin-techdocs-module-addons-contrib` plugin package, which is preinstalled on {product} and enabled by default. The `<ReportIssue />` add-on is part of the default configuration of this plugin package and comes ready to use in the TechDocs plugin.
7+
8+
You can install other supported TechDocs add-ons by configuring the`backstage-plugin-techdocs-module-addons-contrib` plugin package in the {product} ConfigMap or Helm chart, depending on whether you use the Operator or Helm chart for installation. If you want to customize your TechDocs experience beyond the functions of the supported add-ons, you can install third-party add-ons on your TechDocs plugin, including add-ons that you create yourself.
79

810
include::modules/techdocs/proc-techdocs-addon-install-operator.adoc[]
911

assemblies/assembly-techdocs-addons.adoc

+1-1
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 package.
34+
The `backstage-plugin-techdocs-module-addons-contrib` plugin package exports both preinstalled and external add-ons supported by {company-name} to the TechDocs plugin. This plugin package is preinstalled on {product} and is enabled by default. If the plugin package is disabled, all of the TechDocs add-ons exported by the package as also disabled.

0 commit comments

Comments
 (0)