Browse Source

Updates docs/walkthroughs

main
Eric Amodio 2 years ago
parent
commit
0d3ae21b81
17 changed files with 24 additions and 22 deletions
  1. +3
    -3
      CHANGELOG.md
  2. +2
    -2
      README.md
  3. BIN
      images/docs/coming-soon-commit-graph.png
  4. BIN
      images/docs/visual-file-history-hover.png
  5. +0
    -0
      images/docs/visual-file-history-illustrated.png
  6. BIN
      images/docs/worktrees-view.png
  7. +3
    -3
      src/webviews/apps/home/partials/state.free-preview.html
  8. +1
    -1
      src/webviews/apps/home/partials/state.free.html
  9. +0
    -0
      src/webviews/apps/media/plus-visual-file-history-illustrated.png
  10. BIN
      src/webviews/apps/media/plus-visual-file-history.png
  11. BIN
      src/webviews/apps/media/plus-worktrees.png
  12. +5
    -3
      walkthroughs/getting-started/12-plus.md
  13. +1
    -5
      walkthroughs/plus/1-intro.md
  14. +1
    -1
      walkthroughs/plus/3-visual-file-history.md
  15. +8
    -4
      walkthroughs/plus/rich-integrations.md

+ 3
- 3
CHANGELOG.md View File

@ -237,13 +237,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
- 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
![Visual File History view](https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/visual-file-history-hover.png)
![Visual File History view](https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/visual-file-history-illustrated.png)
- Worktrees — allow multiple branches to be checked-out at once
- Worktrees allow you to easily work on different branches of a repository simultaneously. You can create multiple working trees, each of which can be opened in individual windows or all together in a single workspace
![Worktrees view](https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/worktrees-view.png)
![Worktrees view](https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/worktrees-illustrated.png)
- Adds a new GitLens Home view — see welcome content, help resources, and subscription information
- Adds a _Get Started with GitLens_ walkthrough to introduce new (and existing) users to many of the powerful features of GitLens — try it via _GitLens: Get Started_ from the Command Palette
@ -778,7 +778,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
- Integrates line history into the [**_File History_ view**](https://github.com/gitkraken/vscode-gitlens#file-history-view-)
![File History view view](https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/file-history-view.png)
![File History view](https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/file-history-view.png)
- Adds a new _Toggle History Mode_ command to toggle between showing file or line history
- Adds an indicator icon (up arrow) to unpublished (unpushed) commits

+ 2
- 2
README.md View File

@ -81,7 +81,7 @@ No, the introduction of GitLens+ has no impact on existing GitLens features, so
## Visual File History view [#](#visual-file-history-view- 'Visual File History view')
<p align="center">
<img src="https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/visual-file-history-hover.png" alt="Visual File History view" />
<img src="https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/visual-file-history-illustrated.png" alt="Visual File History view" />
</p>
The Visual File History view allows you to quickly see the evolution of a file, including when changes were made, how large they were, and who made them.
@ -93,7 +93,7 @@ Additionally, each commit's additions and deletions are visualized as color-code
## Worktrees view [#](#worktrees-view- 'Worktrees view')
<p align="center">
<img src="https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/worktrees-view.png" alt="Worktrees view" />
<img src="https://raw.githubusercontent.com/gitkraken/vscode-gitlens/main/images/docs/worktrees-illustrated.png" alt="Worktrees view" />
</p>
Worktrees allow you to easily work on different branches of a repository simultaneously. You can create multiple working trees, each of which can be opened in individual windows or all together in a single workspace.

BIN
images/docs/coming-soon-commit-graph.png View File

Before After
Width: 800  |  Height: 450  |  Size: 77 KiB

BIN
images/docs/visual-file-history-hover.png View File

Before After
Width: 800  |  Height: 450  |  Size: 46 KiB

images/docs/file-history-illustrated.png → images/docs/visual-file-history-illustrated.png View File


BIN
images/docs/worktrees-view.png View File

Before After
Width: 800  |  Height: 450  |  Size: 67 KiB

+ 3
- 3
src/webviews/apps/home/partials/state.free-preview.html View File

@ -24,8 +24,8 @@
<h4>Visual File History</h4>
<img
class="image--preview"
src="#{webroot}/media/docs/plus-visual-file-history.webp"
alt="Visual File History screenshot"
src="#{webroot}/media/docs/plus-visual-file-history-illustrated.webp"
alt="Visual File History illustration"
/>
<p class="feature-desc">
The
@ -38,7 +38,7 @@
who made them.
</p>
<h4>Worktrees</h4>
<img class="image--preview" src="#{webroot}/media/plus-worktrees.webp" alt="Worktrees screenshot" />
<img class="image--preview" src="#{webroot}/media/plus-worktrees-illustrated.webp" alt="Worktrees illustration" />
<p class="feature-desc">
<a
title="Learn more about worktrees"

+ 1
- 1
src/webviews/apps/home/partials/state.free.html View File

@ -35,7 +35,7 @@
<h4>Visual File History</h4>
<img
class="image--preview"
src="#{webroot}/media/plus-file-history-illustrated.webp"
src="#{webroot}/media/plus-visual-file-history-illustrated.webp"
alt="Visual File History illustration"
/>
<p class="feature-desc">

src/webviews/apps/media/plus-file-history-illustrated.png → src/webviews/apps/media/plus-visual-file-history-illustrated.png View File


BIN
src/webviews/apps/media/plus-visual-file-history.png View File

Before After
Width: 800  |  Height: 450  |  Size: 46 KiB

BIN
src/webviews/apps/media/plus-worktrees.png View File

Before After
Width: 800  |  Height: 450  |  Size: 67 KiB

+ 5
- 3
walkthroughs/getting-started/12-plus.md View File

@ -1,12 +1,16 @@
## GitLens+ Features
GitLens+ adds all-new, completely optional, features that enhance your current GitLens experience when you sign in with a free account. A free GitLens+ account gives you access to these new GitLens+ features on public repos, while a paid account allows you to use them on private repos.
GitLens+ features include the Commit Graph, Visual File History, Worktrees, and more.
<p align="center">
<img src="../../images/docs/commit-graph-illustrated.png" alt="Commit Graph illustration"/>
<br/>New Commit Graph
</p>
<p align="center">
<img src="../../images/docs/file-history-illustrated.png" alt="Visual File History illustration"/>
<img src="../../images/docs/visual-file-history-illustrated.png" alt="Visual File History illustration"/>
<br/>Visual File History
</p>
@ -14,5 +18,3 @@
<img src="../../images/docs/worktrees-illustrated.png" alt="Worktrees illustration"/>
<br/>Worktrees
</p>
Even more features are coming soon, like rich integrations with GitHub Enterprise.

+ 1
- 5
walkthroughs/plus/1-intro.md View File

@ -6,7 +6,7 @@ GitLens+ adds all-new, completely optional, features that enhance your current G
[Learn more about GitLens+](https://gitkraken.com/gitlens/plus-features?utm_source=gitlens-extension&utm_medium=in-app-links&utm_campaign=gitlens-plus-links 'Learn more')
GitLens+ features include the Commit Graph, Visual File History and Worktrees.
GitLens+ features include the Commit Graph, Visual File History, Worktrees, and more.
<p align="center">
<img src="../../images/docs/commit-graph-illustrated.png" alt="Commit Graph Illustration"/>
@ -16,7 +16,3 @@ GitLens+ features include the Commit Graph, Visual File History and Worktrees.
## Does this affect existing features?
No, the introduction of GitLens+ has no impact on existing GitLens features, so you won't lose access to any of the GitLens features you know and love. In fact, we are heavily investing in enhancing and expanding the GitLens feature set. Creating an account simply gives you access to a subset of new features that will enable you to get even more out of Git in VS Code!
## More GitLens+ features coming soon
Additional features like rich integration with GitHub Enterprise are coming soon.

+ 1
- 1
walkthroughs/plus/3-visual-file-history.md View File

@ -1,7 +1,7 @@
## Visual File History
<p align="center">
<img src="../../images/docs/file-history-illustrated.png" alt="Visual File History View"/>
<img src="../../images/docs/visual-file-history-illustrated.png" alt="Visual File History View"/>
</p>
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.

+ 8
- 4
walkthroughs/plus/rich-integrations.md View File

@ -2,6 +2,14 @@
GitLens+ users with a paid plan can access rich integrations for self-hosted providers.
### GitHub Enterprise
GitHub Enterprise users can see GitHub avatars for commit authors, richer details for auto-linked issues and pull requests, as well as pull requests associated with commits and branches.
<p align="center">
<img src="../../images/docs/hovers-gitlab-integration.png" alt="Commit Hover with GitHub Rich Integration"/>
</p>
### GitLab Self-Managed
GitLab Self-Managed users can see GitLab avatars for commit authors, richer details for auto-linked issues and merge requests, as well as merge requests associated with commits and branches.
@ -9,7 +17,3 @@ GitLab Self-Managed users can see GitLab avatars for commit authors, richer deta
<p align="center">
<img src="../../images/docs/hovers-gitlab-integration.png" alt="Commit Hover with GitLab Rich Integration"/>
</p>
### GitHub Enterprise
A rich integration with GitHub Enterprise is coming soon.

||||||
x
 
000:0
Loading…
Cancel
Save