fix(adoption-insights): mark the app-config app.analytics.adoptionInsights option as optional (#2005)

Signed-off-by: Christoph Jerolimov <[email protected]>

Author: christoph-jerolimov

workspaces/adoption-insights/.changeset/tame-clubs-chew.md

@@ -0,0 +1,6 @@
+---
+'@red-hat-developer-hub/backstage-plugin-analytics-module-adoption-insights': patch
+'@red-hat-developer-hub/backstage-plugin-adoption-insights-backend': patch
+---
+
+Mark the app-config `app.analytics.adoptionInsights` option as optional. It was already read with getOptional<Number/Boolean> so there is no code change or configuration change needed, this just reflect the status quo better.

workspaces/adoption-insights/plugins/adoption-insights-backend/README.md

@@ -23,13 +23,15 @@ backend.add(
 
 ## Configuration
 
+The following optional configuration parameters are available to fine tune adoption analytics events:
+
 ```yaml
 app:
   analytics:
     adoptionInsights:
-      maxBufferSize: 25
-      flushInterval: 6000
-      debug: false # enable this to debug
+      maxBufferSize: 20 # Optional: Maximum buffer size for event batching (default: 20)
+      flushInterval: 5000 # Optional: Flush interval in milliseconds for event batching (default: 5000ms)
+      debug: false # Optional: Enable debug mode to log every event in the browser console (default: false)
       licensedUsers: 100 # Administrators can set this value to see the user adoption metrics.
 ```
 

workspaces/adoption-insights/plugins/adoption-insights-backend/config.d.ts

@@ -16,8 +16,8 @@
 
 export interface Config {
   app?: {
-    analytics: {
-      adoptionInsights: {
+    analytics?: {
+      adoptionInsights?: {
         /**
          * Maximum buffer size for event batching.
          * default 20

workspaces/adoption-insights/plugins/analytics-module-adoption-insights/README.md

@@ -47,9 +47,7 @@ export const apis: AnyApiFactory[] = [AdoptionInsightsAnalyticsApiFactory];
 
 ## Configuration
 
-### Available Configuration Options
-
-The following is the optional configuration required to fine tune adoption analytics events:
+The following optional configuration parameters are available to fine tune adoption analytics events:
 
 ```yaml
 # app-config.yaml

workspaces/adoption-insights/plugins/analytics-module-adoption-insights/config.d.ts

@@ -16,8 +16,8 @@
 
 export interface Config {
   app?: {
-    analytics: {
-      adoptionInsights: {
+    analytics?: {
+      adoptionInsights?: {
         /**
          * Maximum buffer size for event batching.
          * default 20