|
6 | 6 | [id="proc-techdocs-addon-remove-operator_{context}"] |
7 | 7 | == Removing an external TechDocs add-on from your ConfigMap |
8 | 8 |
|
9 | | -If you no longer want to use the functionality of a TechDocs add-on that you installed on your {product} instance using the Operator, remove it from your ConfigMap. |
| 9 | +If you no longer want to use the functionality of a TechDocs add-on that are imported from a particular plugin that you installed on your {product} instance with the Operator, you can temporarily disabled it or permanently remove it from your ConfigMap. The `disabled` status is controlled at the plugin level, therefore, disabling the plugin disables all of the TechDocs add-ons in the disabled plugin package. |
10 | 10 |
|
11 | 11 | .Procedure |
12 | 12 |
|
13 | 13 | . From the Developer perspective in the {ocp-short} web console, click *ConfigMaps*. |
14 | 14 | . From the *ConfigMaps* page, click the ConfigMap that contains the TechDocs add-on that you want to remove. |
15 | 15 | . Select the *YAML view* option in the *Configure via* field. |
16 | | -. In the `techdocsAddons` section of the ConfigMap, delete `importName: _<external_techdocs_add-on>` for each external TechDocs add-on that you want to remove. For example: |
| 16 | +. In the `plugins` section of the ConfigMap, do one of the following actions based on whether you want to disable or remove a TechDocs add-on: |
| 17 | +** To temporarily disable all of the TechDocs add-ons in a particular plugin package, change the value of the `disabled` field to `true`. For example: |
| 18 | ++ |
| 19 | +[source,yaml,subs="+quotes,+attributes"] |
| 20 | +---- |
| 21 | +kind: ConfigMap |
| 22 | +apiVersion: v1 |
| 23 | +metadata: |
| 24 | + name: dynamic-plugins-rhdh |
| 25 | +data: |
| 26 | + dynamic-plugins.yaml: | |
| 27 | + includes: |
| 28 | + - dynamic-plugins.default.yaml |
| 29 | + plugins: |
| 30 | + - package: ./dynamic-plugins/dist/backstage-plugin-techdocs-module-addons-contrib |
| 31 | + disabled: true |
| 32 | + pluginConfig: |
| 33 | + dynamicPlugins: |
| 34 | + frontend: |
| 35 | + backstage.plugin-techdocs-module-addons-contrib: |
| 36 | + techdocsAddons: |
| 37 | + - importName: ReportIssue |
| 38 | + - importName: _<external_techdocs_add-on>_ |
| 39 | +---- |
| 40 | ++ |
| 41 | +where: |
| 42 | + |
| 43 | +_<external_techdocs_add-on>_:: Specifies the external TechDocs add-on that you want to remove, for example, `TextSize`. |
| 44 | +** To permanently remove one or more TechDocs add-ons from a plugin package, delete `importName: _<external_techdocs_add-on>` for each external TechDocs add-on that you want to remove. For example: |
17 | 45 | + |
18 | 46 | [source,yaml,subs="+quotes,+attributes"] |
19 | 47 | ---- |
|
0 commit comments