Skip to content

Commit b808651

Browse files
committed
RHIDP-5422: add link to installation doc + add'l uodates
1 parent 58fa44a commit b808651

File tree

4 files changed

+11
-33
lines changed

4 files changed

+11
-33
lines changed

assemblies/assembly-techdocs-addons-installing.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
:_mod-docs-content-type: ASSEMBLY
22
:context: techdocs-addon-installing
33
[id="techdocs-addon-installing"]
4-
= Installing a TechDocs add-on
4+
= Installing and configuring a TechDocs add-on
5+
6+
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.
57

68
The `<ReportIssue />` add-on is preinstalled in your {product} instance and enabled by default. Like any other supported dynamic plugin, you can install external TechDocs add-ons by using either the Operator or Helm chart. Additionally, you can import compatible third-party add-ons, including add-ons that you create yourself, the same way that you import any other third-party dynamic plugin into {product}.
79

assemblies/assembly-techdocs-addons-removing.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55

66
Administrators can remove installed TechDocs add-ons from your {product} 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.
77

8+
If you want to disable a plugin instead of removing it from your {product} 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.
9+
810
include::modules/techdocs/proc-techdocs-addon-remove-operator.adoc[]
911

1012
include::modules/techdocs/proc-techdocs-addon-remove-helm.adoc[]

modules/techdocs/proc-techdocs-addon-create.adoc

Lines changed: 5 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,8 @@ yarn new
7070
Successfully created plugin
7171
----
7272
+
73-
[NOTE]
74-
====
75-
Running the `yarn new` command automatically generates a sub-directory with
76-
====
77-
+
7873
.Result
79-
In the `plugins` directory, there is an automatically generated sub-directory with the same name that you gave to your plugin. This plugin directory contains all of the files that you need to configure to create your new plugin.
74+
In the `plugins` directory, a sub-directory with the same name that you gave to your plugin is automatically generated. The directory contains all of the files that you need to configure to create your new plugin.
8075
+
8176
. In the terminal, navigate to your new plugin directory. For example:
8277
+
@@ -120,7 +115,6 @@ where
120115
_<new_plugin_for_techdocs_add-on>_ :: Specifies the new plugin that you use to import the TechDocs add-on to your {product} instance.
121116
_<new_techdocs_add-on>_ :: Specifies the custom TechDocs add-on that you want to create.
122117
_<new_techdocs_addon_props>_ (Optional) :: Specifies the `props` for your new TechDocs add-on, as specified in your `_<new_techdocs_add-on>_.tsx` file, if applicable.
123-
. In the `plugins.ts` file, import you new TechDocs add-on component.
124118
_<new_techdocs_add-on_component>_ :: Specifies the React component for the custom TechDocs add-on that you want to create. You will create this component in a `.tsx` file in a later step.
125119
. In the `index.ts` file, export the custom TechDocs add-on that you want to create by adding the following code:
126120
+
@@ -147,29 +141,9 @@ export { _<new_techdocs_add-on>_, type _<new_techdocs_addon_props>_} from './_<n
147141
where
148142
149143
_<new_techdocs_addon_props>_ (Optional) :: Specifies the `props` for your new TechDocs add-on, as specified in your `_<new_techdocs_add-on>_.tsx` file, if applicable.
150-
. In the `plugins.ts` file, import you new TechDocs add-on component.
151-
. Navigate to `packages/app/src/components/catalog/EntityPage.tsx` and your new TechDocs add-on. For example:
152-
+
153-
[source,java,subs="+attributes,+quotes"]
154-
----
155-
...
156-
const techdocsContent = (
157-
<EntityTechdocsContent>
158-
<TechDocsAddons>
159-
<ReportIssue />
160-
<_<new_techdocs_add-on>_ />
161-
</TechDocsAddons>
162-
</EntityTechdocsContent>
163-
);
164-
...
165-
----
144+
. In the `plugins.ts` file, import your new TechDocs add-on component.
145+
. Install and configure your new TechDocs add-on by following the steps in link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/techdocs_for_red_hat_developer_hub/assembly-techdocs-addons-installing.adoc[Installing and configuring a TechDocs add-on].
166146
167147
.Verification
168-
. In the terminal, navigate to the `rbac` directory.
169-
. To start your new TechDocs add-on, run the following command:
170-
+
171-
[source,terminal,subs="+attributes,+quotes"]
172-
----
173-
yarn dev
174-
----
175-
. From the TechDocs plugin in your {product} instance, confirm that your new add-on is working as expected.
148+
. Restart the RHDH application and verify that the plugin is successfully activated and configured.
149+
. Verify the application logs for confirmation and ensure the plugin is functioning as expected.

modules/techdocs/proc-techdocs-addon-use-text-size.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You can use the `TextSize` add-on to change the size of the text on either the T
1212
* The `TextSize` add-on is installed and enabled in your TechDocs plugin.
1313
1414
.Procedure
15-
. On the , click the *Settings* icon.
15+
. In your TechDocs header, click the *Settings* icon.
1616
. Use the sliding scale to adjust the size of your documentation text.
1717
+
1818
[NOTE]

0 commit comments

Comments
 (0)