From d7bf62090b66286d77887cb5e0f50264b1742410 Mon Sep 17 00:00:00 2001 From: linfraze Date: Thu, 27 Mar 2025 16:54:31 -0400 Subject: [PATCH 1/2] RHIDP-6667: Update TechDocs add-ons doc --- assemblies/assembly-techdocs-addons-installing.adoc | 2 +- assemblies/assembly-techdocs-addons.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/assemblies/assembly-techdocs-addons-installing.adoc b/assemblies/assembly-techdocs-addons-installing.adoc index 6e20fd3b08..d559614eb8 100644 --- a/assemblies/assembly-techdocs-addons-installing.adoc +++ b/assemblies/assembly-techdocs-addons-installing.adoc @@ -3,7 +3,7 @@ [id="techdocs-addon-installing"] = Installing and configuring a TechDocs add-on -TechDocs add-ons are supported by {company-name} are imported by the `backstage-plugin-techdocs-module-addons-contrib` plugin package. The `` 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. +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 `` add-on is part of the default configuration of this plugin package and comes ready to use in the TechDocs plugin. 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. include::modules/techdocs/proc-techdocs-addon-install-operator.adoc[] diff --git a/assemblies/assembly-techdocs-addons.adoc b/assemblies/assembly-techdocs-addons.adoc index 7903a09071..1bc9150114 100644 --- a/assemblies/assembly-techdocs-addons.adoc +++ b/assemblies/assembly-techdocs-addons.adoc @@ -31,4 +31,4 @@ The following table describes the TechDocs add-ons that are available for {produ //future release | Expand or collapse the subtitles in the TechDocs navigation menu and keep your preferred state between documentation sites. |=== -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. + The preinstalled and external add-ons supported by {company} are exported to the TechDocs plugin by the `backstage-plugin-techdocs-module-addons-contrib` plugin package. This plugin package is preinstalled on {product} and enabled by default. The `disabled` status of the plugin package applies to all of the TechDocs add-ons that are exported by that package. From 4a6fcd45d588f453597885e975c8ae9ee51948cd Mon Sep 17 00:00:00 2001 From: linfraze Date: Wed, 2 Apr 2025 09:28:18 -0400 Subject: [PATCH 2/2] RHIDP-6667: Apply PR comments --- assemblies/assembly-techdocs-addons-installing.adoc | 4 +++- assemblies/assembly-techdocs-addons.adoc | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/assemblies/assembly-techdocs-addons-installing.adoc b/assemblies/assembly-techdocs-addons-installing.adoc index d559614eb8..9acaa7ef95 100644 --- a/assemblies/assembly-techdocs-addons-installing.adoc +++ b/assemblies/assembly-techdocs-addons-installing.adoc @@ -3,7 +3,9 @@ [id="techdocs-addon-installing"] = Installing and configuring a TechDocs add-on -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 `` add-on is part of the default configuration of this plugin package and comes ready to use in the TechDocs plugin. 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. +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 `` add-on is part of the default configuration of this plugin package and comes ready to use in the TechDocs plugin. + +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. include::modules/techdocs/proc-techdocs-addon-install-operator.adoc[] diff --git a/assemblies/assembly-techdocs-addons.adoc b/assemblies/assembly-techdocs-addons.adoc index 1bc9150114..ea4f380c12 100644 --- a/assemblies/assembly-techdocs-addons.adoc +++ b/assemblies/assembly-techdocs-addons.adoc @@ -31,4 +31,4 @@ The following table describes the TechDocs add-ons that are available for {produ //future release | Expand or collapse the subtitles in the TechDocs navigation menu and keep your preferred state between documentation sites. |=== - The preinstalled and external add-ons supported by {company} are exported to the TechDocs plugin by the `backstage-plugin-techdocs-module-addons-contrib` plugin package. This plugin package is preinstalled on {product} and enabled by default. The `disabled` status of the plugin package applies to all of the TechDocs add-ons that are exported by that package. +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.