Browse Source

Adds walkthrough (wip)

main
Eric Amodio 2 years ago
parent
commit
afa2201f5d
5 changed files with 84 additions and 5 deletions
  1. +28
    -5
      package.json
  2. +10
    -0
      walkthroughs/getting-started/1-setup.md
  3. +11
    -0
      walkthroughs/getting-started/2-customize.md
  4. +10
    -0
      walkthroughs/getting-started/3-current-line-blame.md
  5. +25
    -0
      walkthroughs/getting-started/4-git-codelens.md

+ 28
- 5
package.json View File

@ -10681,15 +10681,38 @@
{
"id": "gitlens.welcome",
"title": "Get Started with GitLens",
"description": "Discover and customize GitLens' most valuable features.",
"description": "Discover and personalize features that supercharge your Git experience",
"steps": [
{
"id": "gitlens.welcome.experience",
"title": "Get Setup Quickly",
"description": "Get started\n\n[Welcome (Quick Setup)](command:gitlens.showWelcomePage \"Opens the GitLens Welcome (Quick Setup)\")",
"media": {
"markdown": "walkthroughs/getting-started/1-setup.md"
}
},
{
"id": "gitlens.welcome.settings",
"title": "Customize GitLens exactly how you want it",
"description": "GitLens provides a rich interactive settings editing experience to allow for seemingly endless customization possibilities.\n\n[Open Settings](command:gitlens.showSettingsPage \"Opens the GitLens Interactive Settings\")",
"media": {
"markdown": "walkthroughs/getting-started/2-customize.md"
}
},
{
"id": "gitlens.welcome.currentLineBlame",
"title": "Current Line Blame",
"description": "The Current Line Blame view shows the blame information for the current line.",
"title": "Understand 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.",
"media": {
"markdown": "walkthroughs/getting-started/3-current-line-blame.md"
}
},
{
"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.",
"media": {
"image": "images/docs/current-line-blame.png",
"altText": "Current Line Blame"
"markdown": "walkthroughs/getting-started/4-git-codelens.md"
}
}
]

+ 10
- 0
walkthroughs/getting-started/1-setup.md View File

@ -0,0 +1,10 @@
## Quick Setup
<p align="center">
<!-- <img src="../../images/docs/settings.png" alt="GitLens Interactive Settings" /> -->
WELCOME IMAGE HERE
</p>
GitLens is powerful, feature rich, and highly customizable to meet your needs. Do you find code lens intrusive or the current line blame annotation distracting — no problem, quickly turn them off or change how they behave using the Quick Setup.
It can be accessed via the [_GitLens: Welcome (Quick Setup)_](command:gitlens.showWelcomePage) command from the [_Command Palette_](command:workbench.action.quickOpen?%22GitLens%3A%Welcome%22).

+ 11
- 0
walkthroughs/getting-started/2-customize.md View File

@ -0,0 +1,11 @@
## Personalize
<p align="center">
<figure>
<img src="../../images/docs/settings.png" alt="GitLens Interactive Settings" />
</figure>
</p>
GitLens provides a rich **interactive settings editor**, an easy-to-use interface, to configure many of GitLens' powerful features.
It can be accessed via the [_GitLens: Open Settings_](command:gitlens.showSettingsPage) command from the [_Command Palette_](command:workbench.action.quickOpen?%22GitLens%3A%20Open%20Settings%22).

+ 10
- 0
walkthroughs/getting-started/3-current-line-blame.md View File

@ -0,0 +1,10 @@
## Current Line Blame
<p align="center">
<img src="../../images/docs/current-line-blame.png" alt="Current Line Blame" />
</p>
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

+ 25
- 0
walkthroughs/getting-started/4-git-codelens.md View File

@ -0,0 +1,25 @@
## Git CodeLens
<p align="center">
<img src="../../images/docs/code-lens.png" alt="Git CodeLens" />
</p>
Adds Git authorship **CodeLens** to the top of the file and on code blocks
- **Recent Change** &mdash; author and date of the most recent commit for the file or code block
- Click the CodeLens to show a **commit file details quick pick menu** with commands for comparing, navigating and exploring commits, and more (by [default](#git-codelens-settings- 'Jump to the Git CodeLens settings'))
- **Authors** &mdash; number of authors of the file or code block and the most prominent author (if there is more than one)
- Click the CodeLens to toggle the file Git blame annotations on and off of the whole file (by [default](#git-codelens-settings- 'Jump to the Git CodeLens settings'))
- Will be hidden if the author of the most recent commit is also the only author of the file or block, to avoid duplicate information and reduce visual noise
- Provides [customizable](command:gitlens.showSettingsPage?%22code-lens%22 'Jump to the Git CodeLens settings') click behavior for each CodeLens &mdash; choose between one of the following
- Toggle file blame annotations on and off
- Compare the commit with the previous commit
- Show a quick pick menu with details and commands for the commit
- Show a quick pick menu with file details and commands for the commit
- Show a quick pick menu with the commit history of the file
- Show a quick pick menu with the commit history of the current branch
- Adds a _Toggle Git CodeLens_ command (`gitlens.toggleCodeLens`) with a shortcut of `shift+alt+b` to toggle the CodeLens on and off

Loading…
Cancel
Save