Merge pull request #941 from github/feature/docs-links

WIP: Add links to documentation.

Author: shana

src/GitHub.App/Info/GitHubUrls.cs

@@ -94,5 +94,10 @@ public static string Billing(this IAccount account)
                 : string.Format(CultureInfo.InvariantCulture,
                     GitHub + "/organizations/{0}/settings/billing", account.Login);
         }
+
+        /// <summary>
+        /// The URL for the GitHub for Visual Studio documentation.
+        /// </summary>
+        public const string Documentation = "https://github.com/github/VisualStudio/tree/master/docs";
     }
 }

src/GitHub.Exports.Reactive/Services/NotificationDispatcher.cs

@@ -54,18 +54,18 @@ public void ShowMessage(string message)
             handler?.ShowMessage(message);
         }
 
-        public void ShowMessage(string message, ICommand command)
+        public void ShowMessage(string message, ICommand command, bool showToolTips = true, Guid guid = default(Guid))
         {
             notifications.OnNext(new Notification(message, Notification.NotificationType.Message, command));
             var handler = notificationHandlers.TryPeek();
-            handler?.ShowMessage(message, command);
+            handler?.ShowMessage(message, command, showToolTips, guid);
         }
 
         public void ShowWarning(string message)
         {
             notifications.OnNext(new Notification(message, Notification.NotificationType.Warning));
             var handler = notificationHandlers.TryPeek();
-            handler.ShowWarning(message);
+            handler?.ShowWarning(message);
         }
 
         public void ShowError(string message)
@@ -75,6 +75,18 @@ public void ShowError(string message)
             handler?.ShowError(message);
         }
 
+        public void HideNotification(Guid guid)
+        {
+            var handler = notificationHandlers.TryPeek();
+            handler?.HideNotification(guid);
+        }
+
+        public bool IsNotificationVisible(Guid guid)
+        {
+            var handler = notificationHandlers.TryPeek();
+            return handler?.IsNotificationVisible(guid) ?? false;
+        }
+
         bool disposed; // To detect redundant calls
         void Dispose(bool disposing)
         {

src/GitHub.Exports/Models/UsageModel.cs

@@ -27,6 +27,9 @@ public class UsageModel
         public int NumberOfForkPullRequestsCheckedOut { get; set; }
         public int NumberOfForkPullRequestPulls { get; set; }
         public int NumberOfForkPullRequestPushes { get; set; }
+        public int NumberOfWelcomeDocsClicks { get; set; }
+        public int NumberOfWelcomeTrainingClicks { get; set; }
+        public int NumberOfGitHubPaneHelpClicks { get; set; }
 
         public UsageModel Clone(bool includeWeekly, bool includeMonthly)
         {
@@ -55,6 +58,9 @@ public UsageModel Clone(bool includeWeekly, bool includeMonthly)
                 NumberOfForkPullRequestsCheckedOut = NumberOfForkPullRequestsCheckedOut,
                 NumberOfForkPullRequestPulls = NumberOfForkPullRequestPulls,
                 NumberOfForkPullRequestPushes = NumberOfForkPullRequestPushes,
+                NumberOfWelcomeDocsClicks = NumberOfWelcomeDocsClicks,
+                NumberOfWelcomeTrainingClicks = NumberOfWelcomeTrainingClicks,
+                NumberOfGitHubPaneHelpClicks = NumberOfGitHubPaneHelpClicks,
             };
         }
     }

src/GitHub.Exports/Services/INotificationService.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Windows.Input;
 
 namespace GitHub.Services
@@ -9,8 +10,10 @@ namespace GitHub.Services
     public interface INotificationService
     {
         void ShowMessage(string message);
-        void ShowMessage(string message, ICommand command);
+        void ShowMessage(string message, ICommand command, bool showToolTips = true, Guid guid = default(Guid));
         void ShowWarning(string message);
         void ShowError(string message);
+        void HideNotification(Guid guid);
+        bool IsNotificationVisible(Guid guid);
     }
 }

src/GitHub.Exports/Services/IUsageTracker.cs

@@ -19,5 +19,8 @@ public interface IUsageTracker
         Task IncrementPullRequestCheckOutCount(bool fork);
         Task IncrementPullRequestPullCount(bool fork);
         Task IncrementPullRequestPushCount(bool fork);
+        Task IncrementWelcomeDocsClicks();
+        Task IncrementWelcomeTrainingClicks();
+        Task IncrementGitHubPaneHelpClicks();
     }
 }

src/GitHub.Exports/Services/StatusBarNotificationService.cs

@@ -20,6 +20,17 @@ public StatusBarNotificationService([Import(typeof(SVsServiceProvider))] IServic
             this.serviceProvider = serviceProvider;
         }
 
+        public void HideNotification(Guid guid)
+        {
+            // status bar only shows text, this is a noop
+        }
+
+        public bool IsNotificationVisible(Guid guid)
+        {
+            // it's only text, there's no way of checking
+            return false;
+        }
+
         public void ShowError(string message)
         {
             ShowText(message);
@@ -30,7 +41,7 @@ public void ShowMessage(string message)
             ShowText(message);
         }
 
-        public void ShowMessage(string message, ICommand command)
+        public void ShowMessage(string message, ICommand command, bool showToolTips = true, Guid guid = default(Guid))
         {
             ShowText(message);
         }

src/GitHub.Exports/Settings/Guids.cs

@@ -12,8 +12,10 @@ public static class Guids
         public const string GitHubServiceProviderId = "76909E1A-9D58-41AB-8957-C26B9550787B";
         public const string StartPagePackageId = "3b764d23-faf7-486f-94c7-b3accc44a70e";
         public const string CodeContainerProviderId = "6CE146CB-EF57-4F2C-A93F-5BA685317660";
+        public const string TeamExplorerWelcomeMessage = "C529627F-8AA6-4FDB-82EB-4BFB7DB753C3";
 
         // VisualStudio IDs
         public const string GitSccProviderId = "11B8E6D7-C08B-4385-B321-321078CDD1F8";
+        public const string TeamExplorerInstall3rdPartyGitTools = "DF785C7C-8454-4836-9686-D1C4A01D0BB9";
     }
 }

src/GitHub.Exports/Settings/generated/IPackageSettings.cs

@@ -12,7 +12,12 @@
         "type": "object",
         "typename": "UIState",
         "default": 'null'
-    }
+    },
+	{
+		"name": "HideTeamExplorerWelcomeMessage",
+		"type": "bool",
+		"default": 'false'
+	}
     ]
 }
 */
@@ -26,5 +31,6 @@ public interface IPackageSettings : INotifyPropertyChanged
         void Save();
         bool CollectMetrics { get; set; }
         UIState UIState { get; set; }
+        bool HideTeamExplorerWelcomeMessage { get; set; }
     }
 }

src/GitHub.TeamFoundation.14/Home/GitHubHomeSection.cs

@@ -13,6 +13,10 @@
 using GitHub.Extensions;
 using System.Windows.Input;
 using ReactiveUI;
+using GitHub.VisualStudio.UI;
+using GitHub.Settings;
+using System.Windows.Threading;
+using GitHub.Info;
 
 namespace GitHub.VisualStudio.TeamExplorer.Home
 {
@@ -21,22 +25,58 @@ namespace GitHub.VisualStudio.TeamExplorer.Home
     public class GitHubHomeSection : TeamExplorerSectionBase, IGitHubHomeSection
     {
         public const string GitHubHomeSectionId = "72008232-2104-4FA0-A189-61B0C6F91198";
-        IVisualStudioBrowser visualStudioBrowser;
+        const string TrainingUrl = "https://services.github.com/on-demand/windows/visual-studio";
+
+        readonly IVisualStudioBrowser visualStudioBrowser;
+        readonly ITeamExplorerServices teamExplorerServices;
+        readonly IPackageSettings settings;
+        readonly IUsageTracker usageTracker;
 
         [ImportingConstructor]
         public GitHubHomeSection(IGitHubServiceProvider serviceProvider,
-            ISimpleApiClientFactory apiFactory, ITeamExplorerServiceHolder holder,
-            IVisualStudioBrowser visualStudioBrowser)
+            ISimpleApiClientFactory apiFactory,
+            ITeamExplorerServiceHolder holder,
+            IVisualStudioBrowser visualStudioBrowser,
+            ITeamExplorerServices teamExplorerServices,
+            IPackageSettings settings,
+            IUsageTracker usageTracker)
             : base(serviceProvider, apiFactory, holder)
         {
             Title = "GitHub";
             View = new GitHubHomeContent();
             View.DataContext = this;
             this.visualStudioBrowser = visualStudioBrowser;
+            this.teamExplorerServices = teamExplorerServices;
+            this.settings = settings;
+            this.usageTracker = usageTracker;
 
             var openOnGitHub = ReactiveCommand.Create();
             openOnGitHub.Subscribe(_ => DoOpenOnGitHub());
             OpenOnGitHub = openOnGitHub;
+
+            // We want to display a welcome message but only if Team Explorer isn't
+            // already displaying the "Install 3rd Party Tools" message. To do this
+            // we need to set a timer and check in the tick as at this point the message
+            // won't be initialized.
+            if (!settings.HideTeamExplorerWelcomeMessage)
+            {
+                var timer = new DispatcherTimer();
+                timer.Interval = new TimeSpan(10);
+                timer.Tick += (s, e) =>
+                {
+                    timer.Stop();
+                    if (!IsGitToolsMessageVisible())
+                    {
+                        ShowWelcomeMessage();
+                    }
+                };
+                timer.Start();
+            }
+        }
+
+        bool IsGitToolsMessageVisible()
+        {
+            return teamExplorerServices.IsNotificationVisible(new Guid(Guids.TeamExplorerInstall3rdPartyGitTools));
         }
 
         protected async override void RepoChanged(bool changed)
@@ -107,6 +147,36 @@ void DoOpenOnGitHub()
             visualStudioBrowser?.OpenUrl(ActiveRepo.CloneUrl.ToRepositoryUrl());
         }
 
+        void ShowWelcomeMessage()
+        {
+            var welcomeMessageGuid = new Guid(Guids.TeamExplorerWelcomeMessage);
+            teamExplorerServices.ShowMessage(
+                Resources.TeamExplorerWelcomeMessage,
+                new RelayCommand(o =>
+                {
+                    var str = o.ToString();
+
+                    switch (str)
+                    {
+                        case "show-training":
+                            visualStudioBrowser.OpenUrl(new Uri(TrainingUrl));
+                            usageTracker.IncrementWelcomeTrainingClicks().Forget();
+                            break;
+                        case "show-docs":
+                            visualStudioBrowser.OpenUrl(new Uri(GitHubUrls.Documentation));
+                            usageTracker.IncrementWelcomeDocsClicks().Forget();
+                            break;
+                        case "dont-show-again":
+                            teamExplorerServices.HideNotification(welcomeMessageGuid);
+                            settings.HideTeamExplorerWelcomeMessage = true;
+                            settings.Save();
+                            break;
+                    }
+                }),
+                false,
+                welcomeMessageGuid);
+        }
+
         protected GitHubHomeContent View
         {
             get { return SectionContent as GitHubHomeContent; }

src/GitHub.TeamFoundation.14/Services/TeamExplorerServices.cs

@@ -43,10 +43,15 @@ public void ShowMessage(string message)
             manager?.ShowNotification(message, NotificationType.Information, NotificationFlags.None, null, default(Guid));
         }
 
-        public void ShowMessage(string message, ICommand command)
+        public void ShowMessage(string message, ICommand command, bool showToolTips = true, Guid guid = default(Guid))
         {
             manager = serviceProvider.GetService<ITeamExplorer, ITeamExplorerNotificationManager>();
-            manager?.ShowNotification(message, NotificationType.Information, NotificationFlags.None, command, default(Guid));
+            manager?.ShowNotification(
+                message,
+                NotificationType.Information,
+                showToolTips ? NotificationFlags.None : NotificationFlags.NoTooltips,
+                command,
+                guid);
         }
 
         public void ShowWarning(string message)
@@ -61,10 +66,22 @@ public void ShowError(string message)
             manager?.ShowNotification(message, NotificationType.Error, NotificationFlags.None, null, default(Guid));
         }
 
+        public void HideNotification(Guid guid)
+        {
+            manager = serviceProvider.GetService<ITeamExplorer, ITeamExplorerNotificationManager>();
+            manager?.HideNotification(guid);
+        }
+
         public void ClearNotifications()
         {
             manager = serviceProvider.GetService<ITeamExplorer, ITeamExplorerNotificationManager>();
             manager?.ClearNotifications();
         }
+
+        public bool IsNotificationVisible(Guid guid)
+        {
+            manager = serviceProvider.GetService<ITeamExplorer, ITeamExplorerNotificationManager>();
+            return manager?.IsNotificationVisible(guid) ?? false;
+        }
     }
 }