You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/techdocs/proc-techdocs-addon-install-helm.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ global:
37
37
Preinstalled add-ons, such as `ReportIssue`, are included in the default package configuration. Additional add-ons are installed by manually adding them to the configuration file.
38
38
====
39
39
40
-
. In the `techdocsAddons` section of the Helm chart, add `importName: _<external_techdocs_add-on>` for each external TechDocs add-on that you want to install. For example:
40
+
. In the `techdocsAddons` section of the Helm chart, add `importName: _<external_techdocs_add-on>` for each external TechDocs add-on that you want to add from the specified plugin package. For example:
Copy file name to clipboardExpand all lines: modules/techdocs/proc-techdocs-addon-install-operator.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ data:
43
43
====
44
44
Preinstalled add-ons, such as `ReportIssue`, are included in the default package configuration. Additional add-ons are installed by manually adding them to the configuration file.
45
45
====
46
-
. In the `techdocsAddons` section of the ConfigMap, add `importName: _<external_techdocs_add-on>` for each external TechDocs add-on that you want to install. For example:
46
+
. In the `techdocsAddons` section of the ConfigMap, add `importName: _<external_techdocs_add-on>` for each external TechDocs add-on that you want to add from the specified plugin package. For example:
The `@latest` tag uses the latest version of the `package.json` file for compatibility with the most recent features and fixes.
34
+
The `@latest` tag pulls the latest version of the @janus-idp/cli package, which is compatible with the most recent features and fixes. Use a version that is compatible with your {product} version.
36
35
====
37
36
. To package the third-party TechDocs add-on as a dynamic plugin, navigate to the root directory where the plugin is stored (not the dist-dynamic directory) and run the `npx` command with the `--tag` option to specify the image name and tag. For example:
_<user_name>>_ :: Specifies your Quay user name or organization name.
81
+
_<user_name>_ :: Specifies your Quay user name or organization name.
85
82
_<techdocs_add-on_image>_ :: Specifies the name of the image for the third-party add-on that you want to use, for example, `mermaid`.
86
83
_<techdocs_add-on_package>_ :: Specifies the , for example, `backstage-plugin-techdocs-addon-mermaid`.
87
84
_<third-party_add-on_name>_ :: Specifies the name of the third-party add-on that you want to use, for example, `Mermaid`.
88
-
_<theme_name>_ :: Specifies the name of the visual theme that you want to apply to your third-party TechDocs add-on, for example, `forest`. Depending on the third-party add-on, this field can be optional or required.
89
-
_<line_color_variable>_ :: Specifies the line color that you want to use in the visual theme, for example, #000000. Depending on the third-party add-on, this field can be optional or required.
85
+
_<techdocs_add-on_property_key>_ :: Specifies the name of the custom property that can be passed to the third-party add-on, for example, `themeVariables`. Properties are specific to each add-on. You can list multiple properties for an add-on.
86
+
_<techdocs_add-on_property_value>_ :: Specifies the value of a property key for the third-party add-on, for example, `lineColor: #000000`.
Copy file name to clipboardExpand all lines: modules/techdocs/proc-techdocs-addon-remove-helm.adoc
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
[id="proc-techdocs-addon-remove-helm_{context}"]
7
7
== Removing an external TechDocs add-on from your Helm chart
8
8
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 Helm chart, you can temporarily disabled 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.
9
+
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 {product} 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.
10
10
11
11
.Procedure
12
12
* In the `plugins` section of the Helm chart, do one of the following actions based on whether you want to disable or remove a TechDocs add-on:
@@ -31,7 +31,7 @@ global:
31
31
where:
32
32
33
33
_<external_techdocs_add-on>_:: Specifies the external TechDocs add-on that you want to remove, for example, `TextSize`.
34
-
** 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:
34
+
** To remove one or more TechDocs add-ons from your {product} instance, delete `importName: _<external_techdocs_add-on>_` for each external TechDocs add-on that you want to remove from the `techdocsAddons` section of your Helm chart. For example:
== 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 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.
9
+
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 {product} 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.
10
10
11
11
.Procedure
12
12
@@ -41,7 +41,7 @@ data:
41
41
where:
42
42
43
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:
44
+
** To remove one or more TechDocs add-ons from your {product} instance, delete `importName: _<external_techdocs_add-on>_` for each external TechDocs add-on that you want to remove from the `techdocsAddons` section of your ConfigMap. For example:
0 commit comments