RHIDP-6667: Update TechDocs add-ons doc #1026
Open
+2
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1026/ @ 03/27/25 21:06:02 |
linfraze
commented
Mar 27, 2025
| @@ -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 `<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. | |||
| 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. 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. | |||
There was a problem hiding this comment.
SME Q - one thing that is confusing is the use of the terms export and import.
Do we import the add-on from [somewhere] to the plugin package and then export the add-on from the plugin package to the TechDocs plugin?
linfraze
added
Peer review needed 📖
Technical review needed 🔩
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s):
1.5.0 / 1.5.1
Issue:
RHIDP-6667