Skip to content

Commit ae74cf1

Browse files
d13d13
committed
Adds home view to walkthrough
1 parent 291838a commit ae74cf1

File tree

9 files changed

+78
-4
lines changed

9 files changed

+78
-4
lines changed

‎docs/telemetry-events.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2023,7 +2023,7 @@ or
20232023
```typescript
20242024
{
20252025
'command': string,
2026-
'name': 'open/help-center/start-integrations' | 'open/help-center/accelerate-pr-reviews' | 'open/help-center/streamline-collaboration' | 'open/help-center/interactive-code-history' | 'open/help-center/community-vs-pro' | 'open/devex-platform' | 'open/drafts' | 'connect/integrations' | 'open/autolinks' | 'open/graph' | 'open/launchpad' | 'create/worktree' | 'open/help-center' | 'plus/sign-up' | 'plus/upgrade' | 'plus/reactivate' | 'open/walkthrough' | 'open/inspect',
2026+
'name': 'open/help-center/start-integrations' | 'open/help-center/accelerate-pr-reviews' | 'open/help-center/streamline-collaboration' | 'open/help-center/interactive-code-history' | 'open/help-center/community-vs-pro' | 'open/help-center/home-view' | 'open/devex-platform' | 'open/drafts' | 'open/home' | 'connect/integrations' | 'open/autolinks' | 'open/graph' | 'open/launchpad' | 'create/worktree' | 'open/help-center' | 'plus/sign-up' | 'plus/upgrade' | 'plus/reactivate' | 'open/walkthrough' | 'open/inspect',
20272027
'type': 'command'
20282028
}
20292029
```
@@ -2032,7 +2032,7 @@ or
20322032

20332033
```typescript
20342034
{
2035-
'name': 'open/help-center/start-integrations' | 'open/help-center/accelerate-pr-reviews' | 'open/help-center/streamline-collaboration' | 'open/help-center/interactive-code-history' | 'open/help-center/community-vs-pro' | 'open/devex-platform' | 'open/drafts' | 'connect/integrations' | 'open/autolinks' | 'open/graph' | 'open/launchpad' | 'create/worktree' | 'open/help-center' | 'plus/sign-up' | 'plus/upgrade' | 'plus/reactivate' | 'open/walkthrough' | 'open/inspect',
2035+
'name': 'open/help-center/start-integrations' | 'open/help-center/accelerate-pr-reviews' | 'open/help-center/streamline-collaboration' | 'open/help-center/interactive-code-history' | 'open/help-center/community-vs-pro' | 'open/help-center/home-view' | 'open/devex-platform' | 'open/drafts' | 'open/home' | 'connect/integrations' | 'open/autolinks' | 'open/graph' | 'open/launchpad' | 'create/worktree' | 'open/help-center' | 'plus/sign-up' | 'plus/upgrade' | 'plus/reactivate' | 'open/walkthrough' | 'open/inspect',
20362036
'type': 'url',
20372037
'url': string
20382038
}
@@ -2042,7 +2042,7 @@ or
20422042

20432043
```typescript
20442044
{
2045-
'context.key': 'integrations' | 'gettingStarted' | 'visualizeCodeHistory' | 'prReviews' | 'streamlineCollaboration'
2045+
'context.key': 'integrations' | 'homeView' | 'gettingStarted' | 'visualizeCodeHistory' | 'prReviews' | 'streamlineCollaboration'
20462046
}
20472047
```
20482048

‎package.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21377,6 +21377,17 @@
2137721377
],
2137821378
"when": "gitlens:plus:state == 6"
2137921379
},
21380+
{
21381+
"id": "welcome-home-view",
21382+
"title": "(New) The Home View",
21383+
"description": "Compact yet powerful, the Home View allows you to start work on an issue or create PRs and new branches in one intelligent view.\n\nImprove workflow visibility with clear paths to take action on:\n\n- What am I actively working on now?\n- What should I work on next?\n- What have I worked on recently?\n\nThe Home View is the perfect companion for developers looking to reduce tedious context switching and stay focused on their work in VS Code.\n\n\n[Open the Home View](command:gitlens.walkthrough.showHomeView)\n$(gitlens-play-button)  [Watch a video on the Home view](command:gitlens.walkthrough.openHomeViewVideo)",
21384+
"media": {
21385+
"markdown": "walkthroughs/welcome/home.md"
21386+
},
21387+
"completionEvents": [
21388+
"onContext:gitlens:walkthroughState:homeView == true"
21389+
]
21390+
},
2138021391
{
2138121392
"id": "visualize-code-history",
2138221393
"title": "Interactive Code History",

‎src/commands/walkthroughs.ts‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -374,3 +374,39 @@ export class WalkthroughOpenStartIntegrations extends GlCommandBase {
374374
void openUrl(url);
375375
}
376376
}
377+
378+
// https://help.gitkraken.com/gitlens/home-view
379+
@command()
380+
export class WalkthroughOpenHomeViewVideo extends GlCommandBase {
381+
constructor(private readonly container: Container) {
382+
super('gitlens.walkthrough.openHomeViewVideo');
383+
}
384+
385+
execute(): void {
386+
const url = urls.homeView;
387+
this.container.telemetry.sendEvent('walkthrough/action', {
388+
type: 'url',
389+
name: 'open/help-center/home-view',
390+
url: url,
391+
});
392+
void openUrl(url);
393+
}
394+
}
395+
396+
// gitlens.showHomeView
397+
@command()
398+
export class WalkthroughShowHomeViewCommand extends GlCommandBase {
399+
constructor(private readonly container: Container) {
400+
super('gitlens.walkthrough.showHomeView');
401+
}
402+
403+
execute(): void {
404+
const command = GlCommand.ShowHomeView;
405+
this.container.telemetry.sendEvent('walkthrough/action', {
406+
type: 'command',
407+
name: 'open/home',
408+
command: command,
409+
});
410+
executeCommand(command);
411+
}
412+
}

‎src/constants.commands.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ type InternalWalkthroughCommands =
8585
| 'gitlens.walkthrough.openAcceleratePrReviews'
8686
| 'gitlens.walkthrough.openCommunityVsPro'
8787
| 'gitlens.walkthrough.openHelpCenter'
88+
| 'gitlens.walkthrough.openHomeViewVideo'
8889
| 'gitlens.walkthrough.openInteractiveCodeHistory'
8990
| 'gitlens.walkthrough.openStartIntegrations'
9091
| 'gitlens.walkthrough.openStreamlineCollaboration'
@@ -95,6 +96,7 @@ type InternalWalkthroughCommands =
9596
| 'gitlens.walkthrough.showAutolinks'
9697
| 'gitlens.walkthrough.showDraftsView'
9798
| 'gitlens.walkthrough.showGraph'
99+
| 'gitlens.walkthrough.showHomeView'
98100
| 'gitlens.walkthrough.showLaunchpad'
99101
| 'gitlens.walkthrough.worktree.create'
100102
| 'gitlens.walkthrough.openDevExPlatform';

‎src/constants.telemetry.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -870,8 +870,10 @@ type WalkthroughActionNames =
870870
| 'open/help-center/streamline-collaboration'
871871
| 'open/help-center/interactive-code-history'
872872
| 'open/help-center/community-vs-pro'
873+
| 'open/help-center/home-view'
873874
| 'open/devex-platform'
874875
| 'open/drafts'
876+
| 'open/home'
875877
| 'connect/integrations'
876878
| 'open/autolinks'
877879
| 'open/graph'

‎src/constants.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ export const trackableSchemes = Object.freeze(
154154
]),
155155
);
156156

157-
const utm = 'utm_source=gitlens-extension&utm_medium=in-app-links';
157+
const utm = 'source=gitlens&product=gitlens&utm_source=gitlens-extension&utm_medium=in-app-links';
158158
export const urls = Object.freeze({
159159
codeSuggest: `https://gitkraken.com/solutions/code-suggest?${utm}`,
160160
cloudPatches: `https://gitkraken.com/solutions/cloud-patches?${utm}`,
@@ -178,6 +178,7 @@ export const urls = Object.freeze({
178178

179179
acceleratePrReviews: `https://help.gitkraken.com/gitlens/gitlens-start-here/?${utm}#accelerate-pr-reviews`,
180180
communityVsPro: `https://help.gitkraken.com/gitlens/gitlens-community-vs-gitlens-pro/?${utm}`,
181+
homeView: `https://help.gitkraken.com/gitlens/home-view/?${utm}&utm_campaign=walkthrough`,
181182
interactiveCodeHistory: `https://help.gitkraken.com/gitlens/gitlens-start-here/?${utm}#interactive-code-history`,
182183
startIntegrations: `https://help.gitkraken.com/gitlens/gitlens-start-here/?${utm}#improve-workflows-with-integrations`,
183184
streamlineCollaboration: `https://help.gitkraken.com/gitlens/gitlens-start-here/?${utm}#streamline-collaboration`,

‎src/telemetry/walkthroughStateProvider.ts‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import type { UsageChangeEvent } from './usageTracker';
1111

1212
export type WalkthroughContextKeys =
1313
| 'gettingStarted'
14+
| 'homeView'
1415
| 'visualizeCodeHistory'
1516
| 'prReviews'
1617
| 'streamlineCollaboration'
@@ -46,6 +47,16 @@ const walkthroughRequiredMapping: Readonly<Map<WalkthroughContextKeys, Walkthrou
4647
usage: [],
4748
},
4849
],
50+
[
51+
'homeView',
52+
{
53+
usage: [
54+
'homeView:shown',
55+
`command:${'gitlens.showHomeView' satisfies GlCommands}:executed`,
56+
`command:${'gitlens.showAccountView' satisfies GlCommands}:executed`,
57+
],
58+
},
59+
],
4960
[
5061
'visualizeCodeHistory',
5162
{

‎walkthroughs/welcome/home.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
### Start and manage your work in the Home View
2+
3+
<a href="command:gitlens.walkthrough.openHomeViewVideo" title="Watch the Home View tutorial video">
4+
<img src="./thumbnails/home-view.jpg" alt="Home View"/>
5+
</a>
6+
7+
Located in the VS Code sidebar, the GitLens Home View provides a centralized dashboard that displays and enables you to Start Work and take action on active issues and recent changes.
8+
9+
[Connect Integrations](command:gitlens.walkthrough.connectIntegrations) with hosting and issue services such as GitHub, GitHub Enterprise Pro, GitLab, GitLab Self-Managed Pro, Jira, Bitbucket, custom servers, and more to help you monitor and take action on branches, issues, and pull requests.
10+
11+
Learn more on our detailed [Home View Help Center Page](command:gitlens.walkthrough.openHomeViewVideo).

‎walkthroughs/welcome/thumbnails/home-view.jpg‎

408 KB
Loading

0 commit comments

Comments
 (0)