From e42d5bcd6d36b33b6509381554fffeb3cca713e7 Mon Sep 17 00:00:00 2001 From: Justin Roberts Date: Wed, 23 Feb 2022 13:39:09 -0700 Subject: [PATCH] Updates walkthroughs - adds headings, and moves the majority of text content to the body of each step - most steps now have a simple, one-line description - adds "try now" section to premium feature walkthrough with a button to try - adds and updates content in premium feature introduction step - removes an unnecessary file --- package.json | 32 ++++++++++++++-------- .../getting-started/10-interactive-rebase-editor | 0 .../10-interactive-rebase-editor.md | 4 +++ walkthroughs/getting-started/11-terminal.md | 2 ++ .../getting-started/12-premium-features.md | 4 +++ walkthroughs/getting-started/2-customize.md | 2 +- .../getting-started/3-current-line-blame.md | 10 ++++--- walkthroughs/getting-started/5-revision-history.md | 4 +++ walkthroughs/getting-started/6-file-annotations.md | 17 +++++++++++- .../getting-started/7-git-side-bar-views.md | 6 ++++ .../8-hosting-service-integrations.md | 6 ++++ .../getting-started/9-git-command-palette.md | 4 +++ walkthroughs/premium-features/1-intro.md | 11 ++++++++ walkthroughs/premium-features/2-worktrees.md | 6 ++++ .../premium-features/3-visual-file-history.md | 8 ++++++ walkthroughs/premium-features/4-coming-soon.md | 4 +++ 16 files changed, 102 insertions(+), 18 deletions(-) delete mode 100644 walkthroughs/getting-started/10-interactive-rebase-editor diff --git a/package.json b/package.json index 1bf787d..5d583ab 100644 --- a/package.json +++ b/package.json @@ -10818,7 +10818,7 @@ { "id": "gitlens.welcome.currentLineBlame", "title": "See who made what changes at a glance", - "description": "At the end of every line of code and in the status bar, GitLens exposes details about the last commit that modified that line, including the author, when the commit was made, and other information like pull request details. Hovering over these blame annotations will reveal more details and links to explore more about the commit.", + "description": "Current line blame provides historical context about line changes.", "media": { "markdown": "walkthroughs/getting-started/3-current-line-blame.md" } @@ -10826,7 +10826,7 @@ { "id": "gitlens.welcome.gitCodeLens", "title": "View Git Authorship Via CodeLens", - "description": "At the top of each file and at the beginning of each block of code, GitLens exposes the most recent commit and number of authors. It does this by leveraging CodeLens, one of the most powerful tools inside VS Code, which provides clickable links exposing commit details and allows you to select from a quick pick menu to compare, navigate and further explore each commit.", + "description": "CodeLens adds contextual authorship information and links at the top of each file and at the beginning of each block of code.", "media": { "markdown": "walkthroughs/getting-started/4-git-codelens.md" } @@ -10834,7 +10834,7 @@ { "id": "gitlens.welcome.revisionHistory", "title": "Easily navigate revision history", - "description": "With just a click of a button, you can navigate backwards and forwards through any file's history. Compare changes over time and see the revision history of the whole file or every individual line of code. Customizable and unobtrusive Git blame annotations are still shown on every line, telling you the author, date, and message for the last commit!", + "description": "", "media": { "markdown": "walkthroughs/getting-started/5-revision-history.md" } @@ -10842,7 +10842,7 @@ { "id": "gitlens.welcome.fileAnnotations", "title": "Customize file annotations", - "description": "See customizable file annotations in the editor's status bar and in the gutter, the space beside the line number. Choose between:\n\nBlame – showing the commit and author for each line.\n\nChanges – highlighting any local, unpublished, changes or lines changed by the most recent commit.\n\nHeatmap – to show how recently lines were changed relative to all the other changes in the file.", + "description": "File annotations place visual indicators in the gutter and status bar that provide additional context about changes. ", "media": { "markdown": "walkthroughs/getting-started/6-file-annotations.md" } @@ -10850,7 +10850,7 @@ { "id": "gitlens.welcome.gitSideBarViews", "title": "View more source control details in the side bar", - "description": "GitLens adds side bar views that provide rich source control details and functionality. GitLens views for Commits, File History, Branches, Remotes, Stashes, Tags, Contributors, and the Search & Compare can be displayed in either the Source Control side bar or on the GitLens side bar.", + "description": "Additional views expose even more Git functionality in your side bar.", "media": { "markdown": "walkthroughs/getting-started/7-git-side-bar-views.md" } @@ -10858,7 +10858,7 @@ { "id": "gitlens.welcome.hostingServiceIntegrations", "title": "Integrate with Git hosting services", - "description": "GitLens provides rich integrations with many remote providers, including GitHub, GitHub Enterprise, GitLab, Gitea, Gerrit, Bitbucket, Bitbucket Server, Azure DevOps and custom servers. Quickly gain insights from pull requests and issues without leaving your codebase.\n\nAll Git host integrations provide issue and pull request auto-linking, while advanced integrations (e.g. GitHub) provide more detailed hover information, plus the ability to associate pull requests with branches/commits, and avatars.", + "description": "Quickly gain insights from pull requests and issues without leaving your codebase.", "media": { "markdown": "walkthroughs/getting-started/8-hosting-service-integrations.md" } @@ -10866,7 +10866,7 @@ { "id": "gitlens.welcome.gitCommandPalette", "title": "Work faster with Git Command Palette", - "description": "The Git Command Palette provides guided, step-by-step access to many common Git commands, as well as quick access to commits (history and search), stashes, and status (current branch and working tree).", + "description": "", "media": { "markdown": "walkthroughs/getting-started/9-git-command-palette.md" } @@ -10874,7 +10874,7 @@ { "id": "gitlens.welcome.interactiveRebaseEditor", "title": "Visualize interactive rebase operations", - "description": "A user-friendly editor to easily configure an interactive rebase session. Simply drag & drop to reorder commits and select which ones you want to edit, squash, or drop.", + "description": "", "media": { "markdown": "walkthroughs/getting-started/10-interactive-rebase-editor.md" } @@ -10905,7 +10905,7 @@ { "id": "gitlens.premium.intro", "title": "Introducting GitLens premium features", - "description": "New premium features like Worktrees and Visual File History can be unlocked with a GitLens Free+ account. Additional premium features like GitHub Enterprise and GitLab Self-Managed integrations, and a visual commit graph are coming soon.\n\n", + "description": "", "media": { "markdown": "walkthroughs/premium-features/1-intro.md" } @@ -10913,7 +10913,7 @@ { "id": "gitlens.premium.worktrees", "title": "Do more with Worktrees", - "description": "Create Worktrees that allow multiple branches to be checked-out at once on the same repository. This makes it easier to develop on, or test multiple branches, by minimizing the context switching between branches.\n\nNote: Worktrees do not yet work with VS Code on the web.", + "description": "Create Worktrees that allow multiple branches to be checked-out at once on the same repository.", "media": { "markdown": "walkthroughs/premium-features/2-worktrees.md" } @@ -10921,7 +10921,7 @@ { "id": "gitlens.premium.visualFileHistory", "title": "Visualize file history", - "description": "Clearly see the history of a file, including: when changes were made, how large they were, and who made them. Authors who have contributed changes to a file are on one axis, and dates on the other. Color-coded dots represent points in time where that author made changes to the file, and vertical lines represent the magnitude of the change in two colors: green for lines added, and red for lines removed.", + "description": "A more visual way to analyze and explore changes made to a file.", "media": { "markdown": "walkthroughs/premium-features/3-visual-file-history.md" } @@ -10929,10 +10929,18 @@ { "id": "gitlens.premium.comingSoon", "title": "More coming soon", - "description": "You can expect more premium features like the GitKraken commit graph, which will help you visualize branch structure and commit history. It not only helps verify your recent Git actions on the repo, but also shows who made what code changes and when.", + "description": "", "media": { "markdown": "walkthroughs/premium-features/4-coming-soon.md" } + }, + { + "id": "gitlens.premium.tryNow", + "title": "Try premium features now", + "description": "Try premium features now, without an account, for 3 days.\n\n[Try Premium GitLens Features](command:gitlens.premium.startPreviewTrial)", + "media": { + "markdown": "walkthroughs/premium-features/5-try-premium-now.md" + } } ] } diff --git a/walkthroughs/getting-started/10-interactive-rebase-editor b/walkthroughs/getting-started/10-interactive-rebase-editor deleted file mode 100644 index e69de29..0000000 diff --git a/walkthroughs/getting-started/10-interactive-rebase-editor.md b/walkthroughs/getting-started/10-interactive-rebase-editor.md index 3a72d81..5137c8b 100644 --- a/walkthroughs/getting-started/10-interactive-rebase-editor.md +++ b/walkthroughs/getting-started/10-interactive-rebase-editor.md @@ -1,3 +1,7 @@ +## Visual Interactive Rebase +

Interactive rebase editor

+ +A user-friendly editor to easily configure an interactive rebase session. Simply drag & drop to reorder commits and select which ones you want to edit, squash, or drop. diff --git a/walkthroughs/getting-started/11-terminal.md b/walkthroughs/getting-started/11-terminal.md index 74f49c7..d97b700 100644 --- a/walkthroughs/getting-started/11-terminal.md +++ b/walkthroughs/getting-started/11-terminal.md @@ -1,3 +1,5 @@ +## Git Details in Your Terminal +

Links in VS Code Terminal

diff --git a/walkthroughs/getting-started/12-premium-features.md b/walkthroughs/getting-started/12-premium-features.md index bab6321..9732127 100644 --- a/walkthroughs/getting-started/12-premium-features.md +++ b/walkthroughs/getting-started/12-premium-features.md @@ -1,3 +1,7 @@ +## Premium GitLens Features +

Visual File History View

+ +Even more features are coming soon, like a visual commit graph and integrations for GitHub Enterprise and GitLab Self-Managed repositories. diff --git a/walkthroughs/getting-started/2-customize.md b/walkthroughs/getting-started/2-customize.md index 57772a1..ff7cd42 100644 --- a/walkthroughs/getting-started/2-customize.md +++ b/walkthroughs/getting-started/2-customize.md @@ -1,4 +1,4 @@ -## Personalize +## Customize GitLens

diff --git a/walkthroughs/getting-started/3-current-line-blame.md b/walkthroughs/getting-started/3-current-line-blame.md index 92e3ec9..bcb15e3 100644 --- a/walkthroughs/getting-started/3-current-line-blame.md +++ b/walkthroughs/getting-started/3-current-line-blame.md @@ -1,14 +1,16 @@ ## Current Line Blame -

- Current Line Blame -

- Adds a [customizable](command:gitlens.showSettingsPage?%22current-line%22 'Jump to the Current Line Blame settings') unobtrusive **blame annotation** at the end of the current line - Contains the author, date, and message of the current line's most recent commit (by default) - Adds a [_Toggle Line Blame Annotations_](command:gitlens.toggleLineBlame) command to toggle the blame annotation on and off

+ Current Line Blame +

+ +Hovering over these blame annotaions will reveal more details and links to explore more about the commit. + +

Current Line Blame Hover

diff --git a/walkthroughs/getting-started/5-revision-history.md b/walkthroughs/getting-started/5-revision-history.md index 60c1b7c..c45818c 100644 --- a/walkthroughs/getting-started/5-revision-history.md +++ b/walkthroughs/getting-started/5-revision-history.md @@ -1,3 +1,7 @@ +## Navigate Revision History +

Revision Navigation

+ +With just a click of a button, you can navigate backwards and forwards through any file's history. Compare changes over time and see the revision history of the whole file or every individual line of code. Customizable and unobtrusive Git blame annotations are still shown on every line, telling you the author, date, and message for the last commit! diff --git a/walkthroughs/getting-started/6-file-annotations.md b/walkthroughs/getting-started/6-file-annotations.md index 717e21f..e4a7b5d 100644 --- a/walkthroughs/getting-started/6-file-annotations.md +++ b/walkthroughs/getting-started/6-file-annotations.md @@ -1,3 +1,18 @@ +## Customizable File Annotations + +See customizable file annotations in the editor's status bar and in the gutter, the space beside the line number. Choose between: + +**Blame** – showing the commit and author for each line.

- Gutter Blame and Heatmap + Gutter Blame +

+ +**Changes** – highlighting any local, unpublished, changes or lines changed by the most recent commit. +

+ Gutter Changes +

+ +**Heatmap** – to show how recently lines were changed relative to all the other changes in the file. +

+ Gutter Heatmap

diff --git a/walkthroughs/getting-started/7-git-side-bar-views.md b/walkthroughs/getting-started/7-git-side-bar-views.md index 4fd4e23..31d6b95 100644 --- a/walkthroughs/getting-started/7-git-side-bar-views.md +++ b/walkthroughs/getting-started/7-git-side-bar-views.md @@ -1,4 +1,10 @@ +## Side Bar Views +

GitLens Side Bar Views Source Control Side Bar Views

+ +GitLens adds side bar views for Commits, File History, Branches, Remotes, Stashes, Tags, Contributors, and the Search & Compare that provide rich source control details and functionality. + +These views can be displayed in either the **GitLens** side bar or on the **Source Control** side bar. diff --git a/walkthroughs/getting-started/8-hosting-service-integrations.md b/walkthroughs/getting-started/8-hosting-service-integrations.md index 5caa951..c53211b 100644 --- a/walkthroughs/getting-started/8-hosting-service-integrations.md +++ b/walkthroughs/getting-started/8-hosting-service-integrations.md @@ -1,3 +1,9 @@ +## Hosting Service Integrations +

Hosting service integrations

+ +GitLens provides rich integrations with many remote providers, including GitHub, GitHub Enterprise, GitLab, Gitea, Gerrit, Bitbucket, Bitbucket Server, Azure DevOps and custom servers. + +All Git host integrations provide issue and pull request auto-linking, while advanced integrations (e.g. GitHub) provide more detailed hover information, plus the ability to associate pull requests with branches/commits, and avatars. diff --git a/walkthroughs/getting-started/9-git-command-palette.md b/walkthroughs/getting-started/9-git-command-palette.md index 55b0525..a149d9b 100644 --- a/walkthroughs/getting-started/9-git-command-palette.md +++ b/walkthroughs/getting-started/9-git-command-palette.md @@ -1,3 +1,7 @@ +## Git Command Palette +

Git command palette

+ +The Git Command Palette provides guided, step-by-step access to many common Git commands, as well as quick access to commits (history and search), stashes, and status (current branch and working tree). diff --git a/walkthroughs/premium-features/1-intro.md b/walkthroughs/premium-features/1-intro.md index e69de29..d3d448a 100644 --- a/walkthroughs/premium-features/1-intro.md +++ b/walkthroughs/premium-features/1-intro.md @@ -0,0 +1,11 @@ +## Introducing GitLens Premium Features + +New premium features like Worktrees and Visual File History can be unlocked with a GitLens Free+ account. Additional premium features like a visual commit graph, and integrations for GitHub Enterprise and GitLab Self-Managed repositories are coming soon. + +**Does this affect existing features?** + +No, the introduction of premium features has no impact on GitLens features that existed prior to v12.0, so you won't lose access to any of the GitLens features you know and love. Creating an account simply gives you access to new, premium features that will enable you to get even more out of Git in VS Code! + +Free+ accounts will be able to access premium features on all public repostories, and a paid account will be required to access premium features on private repositories. + +[Learn More About Premium GitLens Features](https://gitkraken.com/gitlens/premium-features) diff --git a/walkthroughs/premium-features/2-worktrees.md b/walkthroughs/premium-features/2-worktrees.md index 8b4b10e..02d6f8a 100644 --- a/walkthroughs/premium-features/2-worktrees.md +++ b/walkthroughs/premium-features/2-worktrees.md @@ -1,3 +1,9 @@ +## Git Worktrees +

Worktrees View in Side Bar

+ +Worktrees make developing on and testing multiple branches easier, by minimizing the context switching between branches. + +*Note: Worktrees do not yet work with VS Code on the web.* diff --git a/walkthroughs/premium-features/3-visual-file-history.md b/walkthroughs/premium-features/3-visual-file-history.md index bab6321..dbeab7a 100644 --- a/walkthroughs/premium-features/3-visual-file-history.md +++ b/walkthroughs/premium-features/3-visual-file-history.md @@ -1,3 +1,11 @@ +## Visual File History +

Visual File History View

+ +The Visual File History allows you to quickly see the evolution of a file, including when changes were made, how large they were, and who made them. + +Authors who have contributed changes to the file are on the left y-axis to create a swim-lane of their commits over time (the x-axis). Commit are plotted as color-coded (per-author) bubbles, whose size represents the relative magnitude of the changes. + +Additionally, each commit's additions and deletions are visualized as color-coded, stacked, vertical bars, whose height represents the number of affected lines (right y-axis). Added lines are shown in green, while deleted lines are red. diff --git a/walkthroughs/premium-features/4-coming-soon.md b/walkthroughs/premium-features/4-coming-soon.md index 73fbeaa..b89cf87 100644 --- a/walkthroughs/premium-features/4-coming-soon.md +++ b/walkthroughs/premium-features/4-coming-soon.md @@ -1,3 +1,7 @@ +## More Premium Features Coming Soon +

Worktrees View in Side Bar

+ +You can expect more premium features like a visual commit graph for better repo visualization, and integrations with hosting services like GitHub Enterprise and GitLab Self-Managed.