Skip to content

Commit 9f1df9e

Browse files
committed
Rebased branch and modularized content
1 parent abc47ae commit 9f1df9e

14 files changed

+188
-94
lines changed

assemblies/assembly-adoption-insights.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,29 @@ include::modules/observe/adoption-insights/proc-setting-duration-of-data-metrics
3434
//viewing cards
3535
include::modules/observe/adoption-insights/proc-viewing-adoption-insights-card.adoc[leveloffset=+1]
3636

37+
include::modules/observe/adoption-insights/proc-viewing-active-users.adoc[leveloffset=+2]
38+
39+
include::modules/observe/adoption-insights/proc-viewing-total-number-of-users.adoc[leveloffset=+2]
40+
41+
include::modules/observe/adoption-insights/proc-viewing-top-catalog-entities.adoc[leveloffset=+2]
42+
43+
include::modules/observe/adoption-insights/proc-viewing-top-templates.adoc[leveloffset=+2]
44+
45+
include::modules/observe/adoption-insights/proc-viewing-top-techdocs.adoc[leveloffset=+2]
46+
47+
include::modules/observe/adoption-insights/proc-viewing-top-plugins.adoc[leveloffset=+2]
48+
3749
//modify number of displayed records
3850
include::modules/observe/adoption-insights/proc-modify-number-of-displayed-records.adoc[leveloffset=+1]
3951

52+
include::modules/observe/adoption-insights/proc-modify-number-of-displayed-records-in-top-catalog-entities.adoc[leveloffset=+2]
53+
54+
include::modules/observe/adoption-insights/proc-modify-number-of-displayed-records-in-top-templates.adoc[leveloffset=+2]
55+
56+
include::modules/observe/adoption-insights/proc-modify-number-of-displayed-records-in-top-techdocs.adoc[leveloffset=+2]
57+
58+
include::modules/observe/adoption-insights/proc-modify-number-of-displayed-records-in-top-plugins.adoc[leveloffset=+2]
59+
4060
//filter records
4161
include::modules/observe/adoption-insights/proc-filter-records-to-display-spec.adoc[leveloffset=+1]
4262

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To disable the Adoption Insights plugin, complete the following steps:
1919
- package: ./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment
2020
disabled: true
2121
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-adoption-insights:bs_1.35.1__0.0.3!red-hat-developer-hub-backstage-plugin-adoption-insights
22-
disabled: false
22+
disabled: true
2323
pluginConfig:
2424
dynamicPlugins:
2525
frontend:
@@ -38,7 +38,7 @@ To disable the Adoption Insights plugin, complete the following steps:
3838
parent: admin
3939
icon: adoptionInsightsIcon
4040
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-adoption-insights-backend:bs_1.35.1__0.0.4!red-hat-developer-hub-backstage-plugin-adoption-insights-backend
41-
disabled: false
41+
disabled: true
4242
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-analytics-module-adoption-insights:bs_1.35.1__0.0.2!red-hat-developer-hub-backstage-plugin-analytics-module-adoption-insights
4343
disabled: false
4444
pluginConfig:
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-modify-number-of-displayed-records-in-top-catalog-entities_{context}"]
3+
= Modifying the number of displayed records in Top catalog entities
4+
5+
You can modify the number of records that are displayed in the *Top catalog entities* card. You can select any of the following number of records for display:
6+
7+
* *Top 3*
8+
* *Top 5*
9+
* *Top 10*
10+
* *Top 20*
11+
12+
By default, the top three most viewed catalog entities are displayed.
13+
14+
.Procedure
15+
16+
* Go to *Administration -> Adoption Insights* and click the *Down* arrow next to *3 rows* to change the number of displayed records.
17+
18+
image::rhdh-plugins-reference/adoption-insights-catalog-entities.jpg[Catalog Entities dropdown]
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-modify-number-of-displayed-records-in-top-plugins_{context}"]
3+
= Modifying the number of displayed records in Top 3 plugins
4+
5+
You can modify the number of records that are displayed in the *Top 3 plugins* card. You can select any of the following number of records for display:
6+
7+
* *Top 3*
8+
* *Top 5*
9+
* *Top 10*
10+
* *Top 20*
11+
12+
By default, the top three most viewed plugins are displayed.
13+
14+
.Procedure
15+
16+
* Go to *Administration -> Adoption Insights* and click the *Down* arrow next to *3 rows* to change the number of displayed records.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-modify-number-of-displayed-records-in-top-techdocs_{context}"]
3+
= Modifying the number of displayed records in Top 3 techdocs
4+
5+
You can modify the number of records that are displayed in the *Top 3 techdocs* card. You can select any of the following number of records for display:
6+
7+
* *Top 3*
8+
* *Top 5*
9+
* *Top 10*
10+
* *Top 20*
11+
12+
By default, the top three most viewed TechDocs are displayed.
13+
14+
.Procedure
15+
16+
* Go to *Administration -> Adoption Insights* and click the *Down* arrow next to *3 rows* to change the number of displayed records.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-modify-number-of-displayed-records-in-top-templates_{context}"]
3+
= Modifying the number of displayed records in Top 3 templates
4+
5+
You can modify the number of records that are displayed in the *Top 3 templates* card. You can select any of the following number of records for display:
6+
7+
* *Top 3*
8+
* *Top 5*
9+
* *Top 10*
10+
* *Top 20*
11+
12+
By default, the top three most viewed templates are displayed.
13+
14+
.Procedure
15+
16+
* Go to *Administration -> Adoption Insights* and click the *Down* arrow next to *3 rows* to change the number of displayed records.

modules/observe/adoption-insights/proc-modify-number-of-displayed-records.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
[id="proc-modify-number-of-displayed-records_{context}"]
33
= Modifying the number of displayed records
44

5+
You can modify the number of displayed records in Adoption Insights for the following cards.
6+
57
== Modifying the number of displayed records in Top catalog entities
68

79
You can modify the number of records that are displayed in the *Top catalog entities* card. You can select any of the following number of records for display:
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-viewing-active-users_{context}"]
3+
= Viewing the active users
4+
5+
The *Active users* card displays the total number of active users over a specified time range. It also provides a breakdown comparison of *New users* and *Returning users* in a line/area graph format. You can export the user data in a .csv format.
6+
7+
* *Returning users*: Existing users who have logged into {product-short}
8+
9+
* *New users*: New users who have registered and logged into {product-short}
10+
11+
image::rhdh-plugins-reference/active-users.jpg[active users]
12+
13+
.Procedure
14+
15+
* To view the list of active users in your Developer Hub instance, go to *Administration -> Adoption Insights*, see the *Active users* card.
16+
17+
* To view the exact number of users for a particular day, hover over the corresponding date in the *Active users* card.
18+
19+
* To export the user data in a .csv format, click the *Export CSV* label.
Lines changed: 0 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,95 +1,3 @@
11
:_mod-docs-content-type: PROCEDURE
22
[id="proc-viewing-adoption-insights-card_{context}"]
33
= Viewing the Adoption Insights card
4-
5-
== Viewing the active users
6-
7-
The *Active users* card displays the total number of active users over a specified time range. It also provides a breakdown comparison of *New users* and *Returning users* in a line/area graph format. You can export the user data in a .csv format.
8-
9-
* *Returning users*: Existing users who have logged into {product-short}
10-
11-
* *New users*: New users who have registered and logged into {product-short}
12-
13-
image::rhdh-plugins-reference/active-users.jpg[active users]
14-
15-
.Procedure
16-
17-
* To view the list of active users in your Developer Hub instance, go to *Administration -> Adoption Insights*, see the *Active users* card.
18-
19-
* To view the exact number of users for a particular day, hover over the corresponding date in the *Active users* card.
20-
21-
* To export the user data in a .csv format, click the *Export CSV* label.
22-
23-
== Viewing the total number of users
24-
25-
This card displays the total number of users that have license to use {product}. It also provides a comparison of the number of *Logged-in users* and *Licensed users* in numeric and percentage form.
26-
27-
* *Logged-in users*: Total number of users, including licensed and unlicensed users, currently logged in to {product-short}.
28-
29-
* *Licensed users*: Total number of licensed users logged in to {product-short}. You can set the number of licensed users in your {product-short} app-config.yaml file.
30-
31-
.Procedure
32-
33-
* To view the total number of users in your {product-short} instance in numeric and percentage forms, go to *Administration -> Adoption Insights* and see the *Total number of users* card.
34-
35-
* To view a percentage representation of the total number of logged-in users among the total number of licensed users, hover over the tooltip in the *Total number of users* card.
36-
37-
== Viewing the top catalog entities
38-
39-
This card lists the most viewed catalog entities (like components, APIs, and so on) and documentation entries, including usage statistics, in a table.
40-
41-
Each item displays the following details:
42-
43-
* *Name*: Name of the catalog
44-
* *Kind*: Type of the catalog
45-
* *Last used*: The last time the catalog was used
46-
* *Views*: The number of times the catalog was viewed
47-
48-
.Procedure
49-
50-
* To view the most commonly used catalog entities in your {product-short} instance, go to *Administration -> Adoption Insights* and see the *Top catalog entities* card.
51-
52-
* To know more about the displayed catalog entity, hover over the catalog entity name.
53-
54-
== Viewing the top 3 templates
55-
56-
This card lists the three most commonly used templates in a table. You can click the down arrow next to *3 rows* to view the full list of the commonly used templates.
57-
58-
* *Name*: Name of the template
59-
* *Mostly in use by*: Type of user using this template most frequently
60-
* *Executions*: Number of times this template was used
61-
62-
.Procedure
63-
64-
* To view the most commonly used templates in your {product-short} instance, go to *Administration -> Adoption Insights* and see the *Top 3 templates* card.
65-
66-
* To know more about the displayed template, hover over the template name.
67-
68-
== Viewing the top 3 techdocs
69-
70-
This card lists the most viewed documentation entries, including the total views, in a table.
71-
72-
* *Name*: Name of the documentation
73-
* *Entity*: Type of the documentation
74-
* *Last used*: The last time the documentation was viewed
75-
* *Views*: Number of times the documentation was visited
76-
77-
.Procedure
78-
79-
* To view the most commonly used templates in your {product-short} instance, go to *Administration -> Adoption Insights* and see the *Top 3 techdocs* card.
80-
81-
* To know more about the displayed techdocs, hover over the techdocs name.
82-
83-
== Viewing the top 3 plugins
84-
85-
This card lists the three most commonly used plugins in a table. You can click the down arrow next to *3 rows* to view the full list of the commonly used plugins.
86-
87-
* *Name*: Name of the plugin
88-
* *Trend*: Popularity of the plugin as a graph
89-
* *Views*: Number of times this plugin was seen
90-
91-
.Procedure
92-
93-
* To view the most commonly used plugins and the plugin page visit trends in your {product-short} instance, go to *Administration -> Adoption Insights* and see the *Top 3 plugins* card.
94-
95-
* To know more about the displayed plugin, hover over the plugin name.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-top-catalog-entities_{context}"]
3+
= Viewing the top catalog entities
4+
5+
This card lists the most viewed catalog entities (like components, APIs, and so on) and documentation entries, including usage statistics, in a table.
6+
7+
Each item displays the following details:
8+
9+
* *Name*: Name of the catalog
10+
* *Kind*: Type of the catalog
11+
* *Last used*: The last time the catalog was used
12+
* *Views*: The number of times the catalog was viewed
13+
14+
.Procedure
15+
16+
* To view the most commonly used catalog entities in your {product-short} instance, go to *Administration -> Adoption Insights* and see the *Top catalog entities* card.
17+
18+
* To know more about the displayed catalog entity, hover over the catalog entity name.

0 commit comments

Comments
 (0)