Browse Source

Refines walkthrough and messaging

main
Eric Amodio 1 year ago
parent
commit
b432dad100
25 changed files with 141 additions and 452 deletions
  1. +2
    -2
      .github/ISSUE_TEMPLATE/config.yml
  2. +61
    -48
      package.json
  3. +0
    -1
      src/constants.ts
  4. +19
    -5
      src/plus/subscription/subscriptionService.ts
  5. +3
    -3
      src/webviews/apps/home/home.html
  6. +0
    -1
      src/webviews/apps/settings/settings.ts
  7. +0
    -337
      src/webviews/apps/welcome/components/gitlens-plus-logo.ts
  8. +9
    -9
      src/webviews/apps/welcome/welcome.html
  9. +0
    -5
      walkthroughs/welcome/7-git-side-bar-views.md
  10. +0
    -0
      walkthroughs/welcome/account.md
  11. +3
    -2
      walkthroughs/welcome/additional-features.md
  12. +1
    -1
      walkthroughs/welcome/blame.md
  13. +0
    -0
      walkthroughs/welcome/file-annotations.md
  14. +2
    -2
      walkthroughs/welcome/integrations.md
  15. +0
    -0
      walkthroughs/welcome/preview.md
  16. +3
    -2
      walkthroughs/welcome/revision-history.md
  17. +4
    -0
      walkthroughs/welcome/side-bars.md
  18. +0
    -0
      walkthroughs/welcome/trial.md
  19. +0
    -0
      walkthroughs/welcome/tutorial.md

+ 2
- 2
.github/ISSUE_TEMPLATE/config.yml View File

@ -6,6 +6,6 @@ contact_links:
- name: Documentation
url: https://help.gitkraken.com/gitlens
about: Read the GitLens support documentation
- name: GitLens+ Support
- name: GitKraken Support
url: https://gitkraken.com/gitlens-support
about: Get email support for GitLens+ issues and questions
about: Get email support for issues and questions on paid features or relating to your GitKraken account or subscription

+ 61
- 48
package.json View File

@ -4510,59 +4510,54 @@
"category": "GitLens"
},
{
"command": "gitlens.plus.learn",
"title": "Learn about GitLens+ Features",
"category": "GitLens+"
},
{
"command": "gitlens.plus.loginOrSignUp",
"title": "Sign In to GitKraken...",
"category": "GitLens+"
"category": "GitLens"
},
{
"command": "gitlens.plus.logout",
"title": "Sign Out of GitKraken",
"category": "GitLens+"
"category": "GitLens"
},
{
"command": "gitlens.plus.startPreviewTrial",
"title": "Preview Pro",
"category": "GitLens+"
"category": "GitLens"
},
{
"command": "gitlens.plus.manage",
"title": "Manage Your Account...",
"category": "GitLens+"
"category": "GitLens"
},
{
"command": "gitlens.plus.purchase",
"title": "Upgrade to Pro...",
"category": "GitLens+"
"category": "GitLens"
},
{
"command": "gitlens.plus.hide",
"title": "Hide GitLens+ Features",
"category": "GitLens+"
"title": "Hide Pro Features",
"category": "GitLens"
},
{
"command": "gitlens.plus.restore",
"title": "Restore GitLens+ Features",
"category": "GitLens+"
"title": "Restore Pro Features",
"category": "GitLens"
},
{
"command": "gitlens.plus.reset",
"title": "Reset",
"category": "GitLens+"
"category": "GitLens"
},
{
"command": "gitlens.plus.resetRepositoryAccess",
"title": "Reset Repository Access Cache",
"category": "GitLens+"
"category": "GitLens"
},
{
"command": "gitlens.plus.refreshRepositoryAccess",
"title": "Refresh Repository Access",
"category": "GitLens+"
"category": "GitLens"
},
{
"command": "gitlens.getStarted",
@ -4597,37 +4592,37 @@
{
"command": "gitlens.showFocusPage",
"title": "Show Focus View",
"category": "GitLens+",
"category": "GitLens",
"icon": "$(layers)"
},
{
"command": "gitlens.showGraph",
"title": "Show Commit Graph",
"category": "GitLens+",
"category": "GitLens",
"icon": "$(gitlens-graph)"
},
{
"command": "gitlens.showGraphPage",
"title": "Show Commit Graph",
"category": "GitLens+",
"category": "GitLens",
"icon": "$(gitlens-graph)"
},
{
"command": "gitlens.showGraphView",
"title": "Show Commit Graph View",
"category": "GitLens+",
"category": "GitLens",
"icon": "$(gitlens-graph)"
},
{
"command": "gitlens.toggleGraph",
"title": "Toggle Commit Graph",
"category": "GitLens+",
"category": "GitLens",
"icon": "$(gitlens-graph)"
},
{
"command": "gitlens.toggleMaximizedGraph",
"title": "Toggle Maximized Commit Graph",
"category": "GitLens+",
"category": "GitLens",
"icon": "$(gitlens-graph)"
},
{
@ -4643,7 +4638,7 @@
{
"command": "gitlens.showInCommitGraph",
"title": "Open in Commit Graph",
"category": "GitLens+",
"category": "GitLens",
"icon": "$(gitlens-graph)"
},
{
@ -4759,7 +4754,7 @@
{
"command": "gitlens.showTimelinePage",
"title": "Open Visual File History",
"category": "GitLens+",
"category": "GitLens",
"icon": "$(graph-scatter)"
},
{
@ -4775,7 +4770,7 @@
{
"command": "gitlens.showTimelineView",
"title": "Show Visual File History View",
"category": "GitLens+"
"category": "GitLens"
},
{
"command": "gitlens.showWelcomePage",
@ -4785,12 +4780,12 @@
{
"command": "gitlens.showWorktreesView",
"title": "Show Worktrees View",
"category": "GitLens+"
"category": "GitLens"
},
{
"command": "gitlens.showWorkspacesView",
"title": "Show GitKraken Workspaces View",
"category": "GitLens+"
"category": "GitLens"
},
{
"command": "gitlens.compareWith",
@ -5056,12 +5051,12 @@
{
"command": "gitlens.gitCommands.worktree",
"title": "Git Worktree...",
"category": "GitLens+"
"category": "GitLens"
},
{
"command": "gitlens.gitCommands.worktree.open",
"title": "Open Git Worktree...",
"category": "GitLens+"
"category": "GitLens"
},
{
"command": "gitlens.switchAIModel",
@ -14358,7 +14353,7 @@
"title": "Welcome and Tutorial",
"description": "Open the Welcome experience to quickly get started and discover the many powerful GitLens features.\n\n[Open Welcome](command:gitlens.showWelcomePage \"Opens GitLens Welcome\")\nOr, sit back and watch the our Getting Started video.\n\n[Watch Tutorial Video](https://www.youtube.com/watch?v=UQPb73Zz9qk \"Watch the Getting Started video\")\n💡 **Want more control?** Use the interactive [GitLens Settings](command:gitlens.showSettingsPage \"Opens GitLens Settings\") editor to customize GitLens to meet your needs.",
"media": {
"markdown": "walkthroughs/welcome/0-tutorial.md"
"markdown": "walkthroughs/welcome/tutorial.md"
}
},
{
@ -14366,7 +14361,7 @@
"title": "See who made which changes at a glance",
"description": "**Inline blame** and status bar blame provide historical context about line changes.\n**Git CodeLens** adds contextual authorship information at the top of each file and at the beginning of each block of code.\n**Hover** over these blame annotations to reveal more details and actions.\n💡 Use the [Toggle Line Blame](command:workbench.action.quickOpen?%22>GitLens%3A%20Toggle%20Line%20Blame%22) and [Toggle Git CodeLens](command:workbench.action.quickOpen?%22>GitLens%3A%20Toggle%20Git%20CodeLens%22) commands from the Command Palette to turn the annotations on and off.",
"media": {
"markdown": "walkthroughs/welcome/3-current-line-blame.md"
"markdown": "walkthroughs/welcome/blame.md"
}
},
{
@ -14374,7 +14369,7 @@
"title": "Get more context with file annotations",
"description": "Use on-demand whole file annotations to see authorship, recent changes, and a heatmap. Annotations are rendered as visual indicators directly in the editor.\n💡 On an active file, use the [Toggle File Blame](command:workbench.action.quickOpen?%22>GitLens%3A%20Toggle%20File%20Blame%22), [Toggle File Changes](command:workbench.action.quickOpen?%22>GitLens%3A%20Toggle%20File%20Changes%22), and [Toggle File Heatmap](command:workbench.action.quickOpen?%22>GitLens%3A%20Toggle%20File%20Heatmap%22) commands from the Command Palette to turn the annotations on and off.",
"media": {
"markdown": "walkthroughs/welcome/6-file-annotations.md"
"markdown": "walkthroughs/welcome/file-annotations.md"
}
},
{
@ -14382,21 +14377,21 @@
"title": "Effortlessly navigate revision history",
"description": "With just a click of a button, you can navigate backwards and forwards through the history of any file.\nCompare changes over time and see the revision history of the whole file or an individual line.",
"media": {
"markdown": "walkthroughs/welcome/5-revision-history.md"
"markdown": "walkthroughs/welcome/revision-history.md"
}
},
{
"id": "gitlens.welcome.gitSideBarViews",
"title": "Explore repositories from the side bar",
"description": "**GitLens Inspect side bar** is like an x-ray into your code, which focuses on providing contextual information and insights to what you're actively working on. Think about it as the developer tools inspector for your code.\n\n[Open GitLens Inspect](command:workbench.view.extension.gitlensInspect)\n\n**GitLens side bar** is the home of GitKraken teams and collaboration services (e.g. GitKraken Workspaces) as well as discovery, help, and support.\n\n[Open GitLens](command:workbench.view.extension.gitlens)\n\n**Source Control side bar** shows views that are focused on your repositories.\n\n[Open Source Control](command:workbench.view.scm)",
"id": "gitlens.welcome.sidebars",
"title": "Discover the many powerful views",
"description": "We've arranged our views for focus and productivity, although you can easily drag them around to suit your needs.\n\n$(gitlens-gitlens-inspect) **GitLens Inspect**\nLike an x-ray into your code, focused on providing contextual information and insights to what you're actively working on. Think about it as the developer tools inspector for your code.\n\n[Open GitLens Inspect](command:workbench.view.extension.gitlensInspect)\n\n$(gitlens-gitlens) **GitLens**\nQuick access to many GitLens features. Also the home of GitKraken teams and collaboration services (e.g. GitKraken Workspaces), help, and support.\n\n[Open GitLens](command:workbench.view.extension.gitlens)\n\n$(source-control) **Source Control**\nShows additional views that are focused on exploring and managing your repositories.\n\n[Open Source Control](command:workbench.view.scm)\n\n$(gitlens-graph) **(Bottom) Panel**\nConvenient and easy access to the Commit Graph with a dedicated details view.\n\n[Open Commit Graph](command:gitlens.showGraph)\n💡 Use the [Reset Views Layout](command:workbench.action.quickOpen?%22>GitLens%3A%20Reset%20Views%20Layout%22) command to quickly get back to the default layout.",
"media": {
"markdown": "walkthroughs/welcome/7-git-side-bar-views.md"
"markdown": "walkthroughs/welcome/side-bars.md"
}
},
{
"id": "gitlens.welcome.commitGraph",
"title": "Commit Graph ✨",
"description": "Helps you easily visualize your repository and keep track of all work in progress.\nUse the rich commit search to find exactly what you're looking for. It's powerful filters allow you to search by a specific commit, message, author, a changed file or files, or even a specific code change.\n\n[Open Commit Graph](command:gitlens.showGraph)",
"title": "Visualize with the Commit Graph ✨",
"description": "Easily visualize your repository and keep track of all work in progress.\nUse the rich commit search to find exactly what you're looking for. It's powerful filters allow you to search by a specific commit, message, author, a changed file or files, or even a specific code change.\n\n[Open Commit Graph](command:gitlens.showGraph)\n\n💡Quickly toggle the Graph via the [Toggle Commit Graph](command:gitlens.toggleGraph) command\n💡Maximize the Graph via the [Toggle Maximized Commit Graph](command:gitlens.toggleMaximizedGraph) command",
"media": {
"altText": "Illustrations of the Commit Graph view",
"svg": "walkthroughs/welcome/commit-graph.svg"
@ -14404,8 +14399,8 @@
},
{
"id": "gitlens.welcome.workspaces",
"title": "Workspaces ☁️ and Focus ✨",
"description": "Workspaces allow you to easily group and manage multiple repositories together, accessible from anywhere, streamlining your workflow.\nCreate workspaces just for yourself or share (coming soon in GitLens) them with your team for faster onboarding and better collaboration.\n\n[Open Workspaces](command:gitlens.showWorkspacesView)\n\nThe Focus view brings all of your GitHub pull requests and issues into a unified actionable view to help to you more easily juggle work in progress, pending work, reviews, and more.\nQuickly see if anything requires your attention while keeping you focused.\n\n[Open Focus](command:gitlens.showFocusPage)",
"title": "Work smarter with GitKraken Workspaces ☁️ and Focus ✨",
"description": "GitKraken Workspaces allow you to easily group and manage multiple repositories together, accessible from anywhere, streamlining your workflow.\nCreate workspaces just for yourself or share (coming soon in GitLens) them with your team for faster onboarding and better collaboration.\n\n[Open Workspaces](command:gitlens.showWorkspacesView)\n\nThe Focus view brings all of your GitHub pull requests and issues into a unified actionable view to help to you more easily juggle work in progress, pending work, reviews, and more.\nQuickly see if anything requires your attention while keeping you focused.\n\n[Open Focus](command:gitlens.showFocusPage)",
"media": {
"altText": "Illustrations of Focus and Workspaces view",
"svg": "walkthroughs/welcome/workspaces-focus.svg"
@ -14414,19 +14409,37 @@
{
"id": "gitlens.welcome.hostingServiceIntegrations",
"title": "Integrate with Git hosting services",
"description": "Simplify your workflow and quickly gain insights with automatic linking of issues and pull requests across multiple Git hosting platforms including GitHub, GitHub Enterprise ✨, GitLab, GitLab self-managed ✨, Gitea, Gerrit, Google Source, Bitbucket, Bitbucket Server, Azure DevOps, and custom servers.\n\nAll integration provide automatic linking, while rich integrations with GitHub & GitLab offer detailed hover information for autolinks, and correlations between pull requests, branches, and commits, as well as user avatars for added context.\n\n**Define your own autolinks**\nUse autolinks to linkify external references, like Jira issues or Zendesk tickets, in commit messages.\n\n[Configure Autolinks](command:gitlens.showSettingsPage?%22autolinks%22)",
"description": "Simplify your workflow and quickly gain insights with automatic linking of issues and pull requests across multiple Git hosting services including GitHub, GitHub Enterprise ✨, GitLab, GitLab self-managed ✨, Gitea, Gerrit, Google Source, Bitbucket, Bitbucket Server, Azure DevOps, and custom servers.\n\nAll integration provide automatic linking, while rich integrations with GitHub & GitLab offer detailed hover information for autolinks, and correlations between pull requests, branches, and commits, as well as user avatars for added context.\n\n**Define your own autolinks**\nUse autolinks to linkify external references, like Jira issues or Zendesk tickets, in commit messages.\n\n[Configure Autolinks](command:gitlens.showSettingsPage?%22autolinks%22)",
"media": {
"markdown": "walkthroughs/welcome/8-hosting-service-integrations.md"
"markdown": "walkthroughs/welcome/integrations.md"
}
},
{
"id": "gitlens.welcome.gitkraken",
"title": "Cloud Services with a GitKraken account",
"id": "gitlens.welcome.preview",
"title": "Previewing GitLens Pro",
"description": "During your preview, you have access to ✨ features on privately hosted repos. [Learn more](https://www.gitkraken.com/gitlens/plus-features)\n\n[Start Free Pro Trial](command:gitlens.plus.loginOrSignUp)\n\nStart a free Pro trial to get an additional 7 days.",
"media": {
"markdown": "walkthroughs/welcome/preview.md"
},
"when": "gitlens:plus:state == 1"
},
{
"id": "gitlens.welcome.trial",
"title": "Trialing GitLens Pro",
"description": "During your trial, you have access to ✨ features on privately hosted repos and ☁️ features based on the Pro tier. [Learn more](https://www.gitkraken.com/gitlens/plus-features)\n\n[Upgrade to Pro](command:gitlens.plus.purchase)",
"media": {
"markdown": "walkthroughs/welcome/trial.md"
},
"when": "gitlens:plus:state == 3"
},
{
"id": "gitlens.welcome.account",
"title": "Power-up with GitKraken Cloud Services",
"description": "Sign up for access to our developer productivity and collaboration services, e.g. Workspaces, or [sign in](command:gitlens.plus.loginOrSignUp).\n\n[Sign Up](command:gitlens.plus.loginOrSignUp)",
"media": {
"markdown": "walkthroughs/welcome/gitkraken-account.md"
"markdown": "walkthroughs/welcome/account.md"
},
"when": "gitlens:plus:state < 5"
"when": "gitlens:plus:state &gt;= 0 && gitlens:plus:state <= 2"
},
{
"id": "gitlens.welcome.additional",

+ 0
- 1
src/constants.ts View File

@ -204,7 +204,6 @@ export const enum Commands {
GitCommandsWorktreeOpen = 'gitlens.gitCommands.worktree.open',
OpenOrCreateWorktreeForGHPR = 'gitlens.ghpr.views.openOrCreateWorktree',
PlusHide = 'gitlens.plus.hide',
PlusLearn = 'gitlens.plus.learn',
PlusLoginOrSignUp = 'gitlens.plus.loginOrSignUp',
PlusLogout = 'gitlens.plus.logout',
PlusManage = 'gitlens.plus.manage',

+ 19
- 5
src/plus/subscription/subscriptionService.ts View File

@ -200,7 +200,6 @@ export class SubscriptionService implements Disposable {
void this.container.viewCommands;
return [
registerCommand(Commands.PlusLearn, openToSide => this.learn(openToSide)),
registerCommand(Commands.PlusLoginOrSignUp, () => this.loginOrSignUp()),
registerCommand(Commands.PlusLogout, () => this.logout()),
@ -229,8 +228,23 @@ export class SubscriptionService implements Disposable {
}
@debug()
learn(openToSide: boolean = true): void {
void openWalkthrough(this.container.context.extension.id, 'gitlens.plus', undefined, openToSide);
async learnAboutPreviewOrTrial() {
const subscription = await this.getSubscription();
if (subscription.state === SubscriptionState.FreeInPreviewTrial) {
void openWalkthrough(
this.container.context.extension.id,
'gitlens.welcome',
'gitlens.welcome.preview',
false,
);
} else if (subscription.state === SubscriptionState.FreePlusInTrial) {
void openWalkthrough(
this.container.context.extension.id,
'gitlens.welcome',
'gitlens.welcome.trial',
false,
);
}
}
@log()
@ -279,7 +293,7 @@ export class SubscriptionService implements Disposable {
);
if (result === learn) {
this.learn();
void this.learnAboutPreviewOrTrial();
}
} else if (isSubscriptionPaid(this._subscription)) {
void window.showInformationMessage(
@ -513,7 +527,7 @@ export class SubscriptionService implements Disposable {
);
if (result === learn) {
this.learn();
void this.learnAboutPreviewOrTrial();
}
}, 1);
}

+ 3
- 3
src/webviews/apps/home/home.html View File

@ -195,11 +195,11 @@
<a
class="nav-list__item"
href="command:gitlens.showWorkspacesView"
title="Show Workspaces view"
aria-label="Show Workspaces view"
title="Show GitKraken Workspaces view"
aria-label="Show GitKraken Workspaces view"
data-requires="repo"
><code-icon class="nav-list__icon" icon="gl-workspaces-view"></code-icon
><span class="nav-list__label">Workspaces ☁️</span></a
><span class="nav-list__label">GitKraken Workspaces ☁️</span></a
>
<a
class="nav-list__item"

+ 0
- 1
src/webviews/apps/settings/settings.ts View File

@ -16,7 +16,6 @@ import { formatDate, setDefaultDateLocales } from '../shared/date';
import { DOM } from '../shared/dom';
// import { Snow } from '../shared/snow';
import '../welcome/components/gitlens-logo';
import '../welcome/components/gitlens-plus-logo';
const topOffset = 83;
const offset = (new Date().getTimezoneOffset() / 60) * 100;

+ 0
- 337
src/webviews/apps/welcome/components/gitlens-plus-logo.ts
File diff suppressed because it is too large
View File


+ 9
- 9
src/webviews/apps/welcome/welcome.html View File

@ -222,9 +222,9 @@
<a
href="command:gitlens.showWorkspacesView"
data-requires="repo"
title="Show Workspaces view"
aria-label="Show Workspaces view"
><code-icon icon="gl-workspaces-view" size="20"></code-icon>Workspaces ☁️</a
title="Show GitKraken Workspaces view"
aria-label="Show GitKraken Workspaces view"
><code-icon icon="gl-workspaces-view" size="20"></code-icon>GitKraken Workspaces ☁️</a
>
</nav>
<p data-requires="norepo">
@ -236,9 +236,9 @@
class="muted"
href="command:gitlens.showWorkspacesView"
data-requires="repo"
title="Show Workspaces view"
aria-label="Show Workspaces view"
>Workspaces ☁️</a
title="Show GitKraken Workspaces view"
aria-label="Show GitKraken Workspaces view"
>GitKraken Workspaces ☁️</a
>
and
<a
@ -445,9 +445,9 @@
<a
href="command:gitlens.showWorkspacesView"
data-requires="repo"
title="Show Workspaces view"
aria-label="Show Workspaces view"
><code-icon icon="gl-workspaces-view"></code-icon>Workspaces ☁️</a
title="Show GitKraken Workspaces view"
aria-label="Show GitKraken Workspaces view"
><code-icon icon="gl-workspaces-view"></code-icon>GitKraken Workspaces ☁️</a
>
<a
href="command:gitlens.showWorktreesView"

+ 0
- 5
walkthroughs/welcome/7-git-side-bar-views.md View File

@ -1,5 +0,0 @@
<p align="center">
<img src="../../images/docs/side-bar-views.png" alt="All Open Sidebar Views" />
</p>
> Note: GitLens Inspect side bar as shown above has been manually moved into the Secondary Side Bar

walkthroughs/welcome/0-tutorial.md → walkthroughs/welcome/account.md View File


+ 3
- 2
walkthroughs/welcome/additional-features.md View File

@ -1,3 +1,4 @@
<p align="center">
<figure align="center">
<img src="../../images/docs/rebase.gif" alt="Interactive rebase editor"/>
</p>
<figcaption>Interactive rebase editor</figcaption>
</figure>

walkthroughs/welcome/3-current-line-blame.md → walkthroughs/welcome/blame.md View File

@ -5,7 +5,7 @@
<figure align="center">
<img src="../../images/docs/code-lens.png" alt="Git CodeLens" />
<figcaption>CodeLens</figcaption>
<figcaption>Git CodeLens</figcaption>
</figure>
<figure align="center">

walkthroughs/welcome/6-file-annotations.md → walkthroughs/welcome/file-annotations.md View File


walkthroughs/welcome/8-hosting-service-integrations.md → walkthroughs/welcome/integrations.md View File

@ -1,3 +1,3 @@
<p align="center">
<figure align="center">
<img src="../../images/docs/hosting-integrations.png" alt="Hosting service integrations"/>
</p>
</figure>

walkthroughs/welcome/gitkraken-account.md → walkthroughs/welcome/preview.md View File


walkthroughs/welcome/5-revision-history.md → walkthroughs/welcome/revision-history.md View File

@ -1,3 +1,4 @@
<p align="center">
<figure align="center">
<img src="../../images/docs/revision-navigation.gif" alt="Revision Navigation" />
</p>
<figcaption>Revision Navigation</figcaption>
</figure>

+ 4
- 0
walkthroughs/welcome/side-bars.md View File

@ -0,0 +1,4 @@
<figure align="center">
<img src="../../images/docs/side-bar-views.png" alt="All Open Sidebar Views" />
<figcaption>GitLens Inspect side bar as shown above has been manually moved into the Secondary Side Bar</figcaption>
</figure>

+ 0
- 0
walkthroughs/welcome/trial.md View File


+ 0
- 0
walkthroughs/welcome/tutorial.md View File


Loading…
Cancel
Save