Skip to content

Commit b5c6b23

Browse files
committed
Made a few changes
1 parent 834076b commit b5c6b23

File tree

4 files changed

+28
-48
lines changed

4 files changed

+28
-48
lines changed

assemblies/assembly-adoption-insights.adoc

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,30 @@
11
[id="assembly-adoption-insights"]
22
= Adoption Insights
33

4+
The {product} instance comes with the Adoption Insights plugin preinstalled and enabled by default.
45

5-
//about adoption insights
6-
include::modules/observe/adoption-insights/con-about-adoption-insights.adoc[leveloffset=+1]
6+
As organizations generate an increasing number of data events, there is a growing need for detailed insights into the adoption and engagement metrics of the internal developer portal. These insights help platform engineers make data-driven decisions to improve its performance, usability, and translate them into actionable insights.
77

8-
//installing adoption insights
9-
include::modules/observe/adoption-insights/proc-install-adoption-insights.adoc[leveloffset=+1]
8+
You can use Adoption Insights in {product} to visualize key metrics and trends to get information about the usage of {product-short} in your organization. The information provided by Adoption Insights in {product-short} pinpoints areas of improvement, highlights popular features, and evaluates progress toward adoption goals. You can also monitor user growth against license users and identify trends over time.
9+
10+
The Adoption Insights dashboard in {product-short} includes the following cards:
11+
12+
* *Active users*
13+
* *Total nuber of users*
14+
* *Top catalog entities*
15+
* *Top 3 templates*
16+
* *Top 3 techdocs*
17+
* *Top 3 plugins*
18+
* *Portal searches*
19+
20+
image::rhdh-plugins-reference/adoption-insights.jpg[adoption insights]
1021

1122
//configuring adoption insights
1223
include::modules/observe/adoption-insights/proc-configure-adoption-insights.adoc[leveloffset=+1]
1324

25+
//disabling adoption insights
26+
include::modules/observe/adoption-insights/proc-disable-adoption-insights.adoc[leveloffset=+1]
27+
1428
//using adoption insights
1529
include::modules/observe/adoption-insights/proc-using-adoption-insights.adoc[leveloffset=+1]
1630

modules/observe/adoption-insights/con-about-adoption-insights.adoc

Lines changed: 0 additions & 19 deletions
This file was deleted.

modules/observe/adoption-insights/proc-configure-adoption-insights.adoc

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,9 @@
22
[id="proc-configure-adoption-insights_{context}"]
33
= Configuring the Adoption Insights plugin in {product}
44

5-
You can enable the Adoption Insights plugin by configuring the {product} Helm chart or the {product} Operator ConfigMap.
5+
The Adoption Insights plugin is preinstalled and enabled on a {product-short} instance by default. You can disable or enable the Adoption Insights plugin, and change other parameters, by configuring the {product} Helm chart or the {product} Operator ConfigMap.
66

7-
.Procedure
8-
9-
* To configure the Adoption Insights plugin in {product-short}, in your {product} `app-config.yaml` file, add the following code:
10-
+
11-
.`app-config.yaml` fragment
12-
[source,terminal]
13-
----
14-
app:
15-
analytics:
16-
adoptionInsights:
17-
maxBufferSize: 20 <1>
18-
flushInterval: 5000 <2>
19-
debug: false <3>
20-
licensedUsers: 2000 <4>
21-
----
22-
<1> (Optional) Specifies the maximum buffer size for event batching. The default value is `20`.
23-
<2> (Optional) Specifies the flush interval in milliseconds for event batching. The default value is `5000ms`.
24-
<3> (Optional) The default value is `false`.
25-
<4> (Optional) Specifies the maximum number of licensed users who can access the RHDH instance. The default value is `100`.
7+
[IMPORTANT]
8+
====
9+
{product} includes a built-in Adoption Insights builder that generates static HTML documentation from your codebase. However, the default basic setup of the local builder is not intended for production.
10+
====

modules/observe/adoption-insights/proc-install-adoption-insights.adoc renamed to modules/observe/adoption-insights/proc-disable-adoption-insights.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33
// * assemblies/assembly-rhdh-observability.adoc
44

55
:_mod-docs-content-type: PROCEDURE
6-
[id="proc-install-adoption-insights_{context}"]
7-
= Installing the Adoption Insights plugin in {product}
6+
[id="proc-disable-adoption-insights_{context}"]
7+
= Disabling the Adoption Insights plugin in {product}
88

9-
For the {product} Adoption Insights plugin, you must manually install the plugin.
9+
For the {product} Adoption Insights plugin, you must manually disable the plugin.
1010

1111
.Procedure
1212

13-
To enable the Adoption Insights plugin, complete the following steps:
13+
To disable the Adoption Insights plugin, complete the following steps:
1414

15-
. Add the following configuration in your `app-config-dynamic.yaml` file as shown in the following example:
15+
. Update the following configuration in your `app-config-dynamic.yaml` file as shown in the following example:
1616
+
1717
[source,yaml]
1818
----

0 commit comments

Comments
 (0)