DYN-6965 Add analytics to track nodes with missing documentation (#15287

)
DynamoDS · Jun 5, 2024 · 56f13e7 · 56f13e7
1 parent 01a8539
commit 56f13e7
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/src/DocumentationBrowserViewExtension/MarkdownHandler.cs b/src/DocumentationBrowserViewExtension/MarkdownHandler.cs
@@ -1,5 +1,6 @@
 using System;
 using System.IO;
+using Dynamo.Logging;
 using Dynamo.Utilities;
 
 namespace Dynamo.DocumentationBrowser
@@ -69,6 +70,12 @@ internal string ParseToHtml(string nodeNamespace, string packageName)
                 if (string.IsNullOrWhiteSpace(mdString))
                     return string.Empty;
             }
+            else
+            {
+                var nodeName = string.IsNullOrEmpty(packageName) ? nodeNamespace : "Package:" + packageName + " " + nodeNamespace;
+                //if in-depth documentatiuon is not available, do not show any additional message, but log it for analytics
+                Analytics.TrackEvent(Actions.MissingDocumentation, Categories.NodeContextMenuOperations, nodeName);
+            }
 
             var html = converter.ParseMd2Html(mdString, mdFilePath);
             return html;

diff --git a/src/NodeServices/IAnalyticsClient.cs b/src/NodeServices/IAnalyticsClient.cs
@@ -413,6 +413,11 @@ public enum Actions
         /// </summary>
         ViewDocumentation,
 
+        /// <summary>
+        /// When the in-depth node help documentation is un-available
+        /// </summary>
+        MissingDocumentation,
+
         /// <summary>
         /// Cancel operation, e.g. cancel adding a new group style 
         /// </summary>