4.2. Removing a TechDocs add-on
Administrators can remove installed TechDocs add-ons from your Red Hat Developer Hub instance by using either the Operator or Helm chart, depending on the method used to install the add-on. If you used the Operator to install the add-on, remove it from the ConfigMap. If you used the Helm chart to install the add-on, remove it from the Helm chart.
If you want to disable a plugin instead of removing it from your Red Hat Developer Hub instance, you can disable the plugin that you are using to import the TechDocs add-on. Since the disabled status is controlled at the plugin level, disabling the plugin disables all of the TechDocs add-ons in the specified plugin package.
4.2.1. Removing an external TechDocs add-on from your ConfigMap 링크 복사링크가 클립보드에 복사되었습니다!
If you no longer want to use the functionality of a TechDocs add-on that is imported from a particular plugin that you installed on your Red Hat Developer Hub instance with the Operator, you can temporarily disable 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.
Procedure
- From the Developer perspective in the OpenShift Container Platform web console, click ConfigMaps.
- From the ConfigMaps page, click the ConfigMap that contains the TechDocs add-on that you want to remove.
- Select the YAML view option in the Configure via field.
In the
pluginssection of the ConfigMap, do one of the following actions based on whether you want to disable or remove a TechDocs add-on:To temporarily disable all of the TechDocs add-ons in a particular plugin package, change the value of the
disabledfield totrue. For example:kind: ConfigMap apiVersion: v1 metadata: name: dynamic-plugins-rhdh data: dynamic-plugins.yaml: | includes: - dynamic-plugins.default.yaml plugins: - package: ./dynamic-plugins/dist/backstage-plugin-techdocs-module-addons-contrib disabled: true pluginConfig: dynamicPlugins: frontend: backstage.plugin-techdocs-module-addons-contrib: techdocsAddons: - importName: ReportIssue - importName: <external_techdocs_add-on>where:
- <external_techdocs_add-on>
-
Specifies the external TechDocs add-on that you want to remove, for example,
TextSize.
To remove one or more TechDocs add-ons from your Red Hat Developer Hub instance, delete
importName: <external_techdocs_add-on>for each external TechDocs add-on that you want to remove from thetechdocsAddonssection of your ConfigMap. For example:kind: ConfigMap apiVersion: v1 metadata: name: dynamic-plugins-rhdh data: dynamic-plugins.yaml: | includes: - dynamic-plugins.default.yaml plugins: - package: ./dynamic-plugins/dist/backstage-plugin-techdocs-module-addons-contrib disabled: false pluginConfig: dynamicPlugins: frontend: backstage.plugin-techdocs-module-addons-contrib: techdocsAddons: - importName: ReportIssue - importName: <external_techdocs_add-on>where:
- <external_techdocs_add-on>
-
Specifies the external TechDocs add-on that you want to remove, for example,
TextSize.
- Click Save.
- In the web console navigation menu, click Topology and wait for the Red Hat Developer Hub pod to start.
- Click the Open URL icon to start using the Red Hat Developer Hub platform with the new configuration changes.
4.2.2. Removing an external TechDocs add-on from your Helm chart 링크 복사링크가 클립보드에 복사되었습니다!
If you no longer want to use the functionality of a TechDocs add-on that is imported from a particular plugin that you installed on your Red Hat Developer Hub instance with the Helm chart, you can temporarily disable it or permanently remove it from your Helm chart. 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.
Procedure
In the
pluginssection of the Helm chart, do one of the following actions based on whether you want to disable or remove a TechDocs add-on:To temporarily disable all of the TechDocs add-ons in a particular plugin package, change the value of the
disabledfield totrue. For example:global: dynamic: plugins: - package: ./dynamic-plugins/dist/backstage-plugin-techdocs-module-addons-contrib disabled: true pluginConfig: dynamicPlugins: frontend: backstage.plugin-techdocs-module-addons-contrib: techdocsAddons: - importName: ReportIssue - importName: <external_techdocs_add-on>where:
- <external_techdocs_add-on>
-
Specifies the external TechDocs add-on that you want to remove, for example,
TextSize.
To remove one or more TechDocs add-ons from your Red Hat Developer Hub instance, delete
importName: <external_techdocs_add-on>for each external TechDocs add-on that you want to remove from thetechdocsAddonssection of your Helm chart. For example:global: dynamic: plugins: - package: ./dynamic-plugins/dist/backstage-plugin-techdocs-module-addons-contrib disabled: false pluginConfig: dynamicPlugins: frontend: backstage.plugin-techdocs-module-addons-contrib: techdocsAddons: - importName: ReportIssue - importName: <external_techdocs_add-on>where:
- <external_techdocs_add-on>
-
Specifies the external TechDocs add-on that you want to remove, for example,
TextSize.