Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 86d0713

Browse files
Merge pull request #126 from jjsilva4/purple-docs-pass/round-6
Updates GitLens documentation for latest features
2 parents bed00f0 + e14953f commit 86d0713

File tree

7 files changed

+487
-178
lines changed

7 files changed

+487
-178
lines changed

‎gitlens/GL-Cloud-Patches.md

Lines changed: 68 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,97 @@
11
---
2-
3-
title: Gitlens Cloud Patches
4-
description: Learn about Cloud Patches in Gitlens
2+
title: GitLens Cloud Patches
3+
description: Use GitLens Cloud Patches to securely share work-in-progress changes across GitKraken tools for early collaboration.
54
taxonomy:
65
category: gitlens
76

87
---
98

9+
<kbd>Last updated: August 2025</kbd>
10+
11+
## What Are Cloud Patches?
12+
13+
A **Cloud Patch** is a Git patch securely stored by GitKraken so it can be easily shared across **GitLens**, **GitKraken Desktop**, and the **GitKraken CLI**.
14+
The patch is transferred directly from your machine into secure storage.
1015

11-
### What are Cloud Patches and why would you want to use them
16+
Cloud Patches let you collaborate with your team **before creating a pull request**. You can share work in progress, gather feedback early, and minimize delays in pull request reviews.
1217

13-
A Cloud Patch is a Git patch that GitKraken securely stores for you so it can be easily shared with others across GitLens, GitKraken Desktop, and the GitKraken CLI. The patch is directly transferred from your machine into secure storage.
18+
---
1419

15-
Cloud Patches allow the ability to engage early with your team before a pull request. They can be created as soon as you have a work in progress. This can help with collaborating on changes prior to a pull request and minimize the delay of pull request reviews.
20+
## Set Up Cloud Patches
1621

17-
### How to setup Cloud Patches
22+
To enable or disable Cloud Patches per client:
1823

19-
To enable Cloud Patches per client, open the user Settings (`command/ctrl + shift + P` > `Preferences: Open User Settings (JSON)`) and set `gitlens.cloudPatches.enabled` to `true` - this is on by default. To disable Cloud Patches per client, set this setting to `false` .
24+
1. Open the Command Palette:
25+
- macOS: <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>
26+
- Windows/Linux: <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>
27+
2. Search for **Preferences: Open User Settings (JSON)**.
28+
3. Set the value of `gitlens.cloudPatches.enabled`:
29+
- `true` = enabled (default)
30+
- `false` = disabled
2031

21-
### How to work with Cloud Patches
32+
---
2233

23-
Cloud Patches can be managed from the Cloud Patches view in the GitLens side bar.
34+
## Create and Share Cloud Patches
2435

25-
<imgsrc="/wp-content/uploads/gl-cloud-patch-create.webp"class="help-center-img img-bordered">
36+
You can manage Cloud Patches from the **Cloud Patches view** in the GitLens sidebar.
2637

27-
A Cloud Patch can be created from Working Changes, Commits, Stashes or Comparisons by using the "Share as Cloud Patch" option from the command palette or from the Share submenu in applicable gitlens views.
38+
<figure>
39+
<img src="/wp-content/uploads/gl-cloud-patch-create.webp" class="help-center-img img-bordered" alt="Creating a Cloud Patch from the GitLens sidebar" />
40+
<figcaption style="text-align: center; color: #888">Creating a Cloud Patch</figcaption>
41+
</figure>
2842

29-
<img src="/wp-content/uploads/gl-create-cloud-patch-example.png" class="help-center-img img-bordered">
43+
A Cloud Patch can be created from **Working Changes, Commits, Stashes, or Comparisons** by selecting **Share as Cloud Patch** from either:
44+
- The Command Palette
45+
- The **Share** submenu in applicable GitLens views
3046

31-
When creating a Cloud Patch, you have the following sharing options:
47+
<figure>
48+
<img src="/wp-content/uploads/gl-create-cloud-patch-example.png" class="help-center-img img-bordered" alt="Creating a Cloud Patch from working changes in GitLens" />
49+
<figcaption style="text-align: center; color: #888">Example of creating a Cloud Patch</figcaption>
50+
</figure>
3251

33-
- `Anyone with the link`: Anyone that you share the public link with will be able to work with the Cloud Patch.
52+
### Sharing Options
53+
When creating a Cloud Patch, choose one of the following:
3454

35-
- `Anyone in my org`: Anyone in the GitKraken Organization will be able to work with the Cloud Patch. They will be required to authenticate with a GitKraken account to access it.
55+
- **Anyone with the link**: Public access for anyone with the link.
56+
- **Anyone in my org**: Accessible to members of your GitKraken Organization (authentication required).
57+
- **Only collaborators**: Restricted to selected GitKraken Organization members (authentication required). Use **Invite** to select members.
3658

37-
-`Only collaborators`: Only users in the GitKraken Organization who have been selected when sharing will be able to work with the Cloud Patch. They will be required to authenticate with a GitKraken account to access it. Select `Invite` to select desired members.
59+
Cloud Patches shared with you appear under **Shared with Me** in the Cloud Patches section.
3860

39-
Cloud Patches shared with you can be viewed in the Cloud Patches section under `Shared with Me`.
61+
<figure>
62+
<img src="/wp-content/uploads/gl-cloud-patch-sharing-options-2.png" class="help-center-img img-bordered" alt="Sharing options for a Cloud Patch in GitLens" />
63+
<figcaption style="text-align: center; color: #888">Cloud Patch sharing options</figcaption>
64+
</figure>
4065

41-
<div class='callout callout--basic'>
42-
<p>Note: If you have multiple organizations, you can easily switch between them from the GitKraken Account view.</p>
43-
</div>
66+
---
67+
68+
## Apply and Manage Cloud Patches
69+
70+
- Open a Cloud Patch from a shared URL to view it in GitLens.
71+
- Apply it to your **working tree** or to a **new/existing branch** by following the prompts in GitLens.
4472

45-
<img src="/wp-content/uploads/gl-cloud-patch-sharing-options-2.png" class="help-center-img img-bordered">
73+
<figure>
74+
<img src="/wp-content/uploads/gl-apply-patch-example.gif" class="help-center-img img-bordered" alt="Applying a Cloud Patch in GitLens" />
75+
<figcaption style="text-align: center; color: #888">Applying a Cloud Patch</figcaption>
76+
</figure>
4677

47-
Cloud Patches can be viewed from URLs shared to you and they can be applied to your working tree or to a new or existing branch. Simply select or open the link and then follow the prompts within GitLens to apply the Cloud Patch.
78+
### Delete a Cloud Patch
79+
1. Right-click the patch in the Cloud Patches view.
80+
2. Select **Delete Cloud Patch...**
4881

49-
<img src="/wp-content/uploads/gl-apply-patch-example.gif" class="help-center-img img-bordered">
82+
<figure>
83+
<img src="/wp-content/uploads/gl-delete-cloud-patch.png" class="help-center-img img-bordered" alt="Deleting a Cloud Patch in GitLens" />
84+
<figcaption style="text-align: center; color: #888">Deleting a Cloud Patch</figcaption>
85+
</figure>
5086

51-
To delete a cloud patch, right-click it and select `Delete Cloud Patch...`.
87+
---
88+
89+
## Self-Host Cloud Patch Data
5290

53-
<imgsrc="/wp-content/uploads/gl-delete-cloud-patch.png"class="help-center-img img-bordered">
91+
If you do not want Cloud Patch data stored on GitKraken servers, you can host Cloud Patches on your own **AWS S3 storage instance**.
5492

55-
### Self-Hosting Cloud Patch data
93+
For configuration instructions, see [Self-Hosted Documentation](/gk-dev/gk-dev-home/#self-hosted).
5694

57-
If you do not want your Cloud Patch data stored on GitKraken Servers, we offer the ability for you to host Cloud Patches on your own AWS S3 storage instance. For more information on configuring this, see our documentation [here](/gk-dev/gk-dev-home/#self-hosted).
95+
<div class='callout callout--basic'>
96+
<p>Note: If you belong to multiple organizations, you can switch between them from the GitKraken Account view.</p>
97+
</div>

‎gitlens/GL-Code-Suggest.md

Lines changed: 64 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,82 @@
11
---
2-
3-
title: Gitlens Code Suggest
4-
description: Code Suggest in Gitlens
2+
title: GitLens Code Suggest
3+
description: Use GitLens Code Suggest to propose edits and code review suggestions across entire projects in GitHub repositories.
54
taxonomy:
65
category: gitlens
76

87
---
98

9+
<kbd>Last updated: August 2025</kbd>
1010

11-
GitKraken Code Suggest simplifies code review by allowing you to make suggestions and edits across the entire project, not just on the lines that were changed, within GitLens, GitKraken Desktop, and gitkraken.dev. When a Pull Request is open, you can make suggestions to the pull request that others can then review and accept to include in the pull request.
11+
## What Is Code Suggest?
1212

13-
<div class='callout callout--basic'>
14-
<p>Note: Code Suggest is currently only available for repositories on github.com.</p>
15-
</div>
13+
**GitLens Code Suggest** simplifies code review by allowing you to make suggestions and edits across the entire project, not just on changed lines.
14+
Suggestions can be created within **GitLens**, **GitKraken Desktop**, or **gitkraken.dev** and attached to pull requests.
1615

17-
<imgsrc="/wp-content/uploads/gl-code-suggest.png"class="help-center-img img-bordered">
16+
Reviewers can then view, accept, and apply these suggestions directly to the pull request branch.
1817

19-
To begin suggesting changes, open the [GitLens Inspect Overview](/gitlens/side-bar/#overview) for the desired repository and checkout a branch that has an open pull request. From here, you will have the option to _Start Review for PR #PR_. You may begin modifying and saving any file you would like to include in the code suggestion. Once you are ready, select _Suggest Changes for PR_, provide a title, and then finish with _Create Code Suggestion_.
18+
<figure>
19+
<img src="/wp-content/uploads/gl-code-suggest.png" class="help-center-img img-bordered" alt="GitLens Code Suggest view showing suggestion options" />
20+
<figcaption style="text-align: center; color: #888">GitLens Code Suggest view</figcaption>
21+
</figure>
2022

21-
<imgsrc="/wp-content/uploads/gl-code-suggest-create.gif"class="help-center-img img-bordered">
23+
---
2224

23-
This will include a comment on the pull request with two options: you can select _Code Suggestion for #PR_ to open the suggestion in gitkraken.dev or select _locally on your machine_ to open the suggestion in GitKraken or GitLens.
25+
## Start a Code Suggestion
2426

25-
<img src="/wp-content/uploads/gl-code-suggest-comment.png" class="help-center-img img-bordered">
27+
1. Open the [GitLens Inspect Overview](/gitlens/side-bar/#overview) for your repository.
28+
2. Check out a branch with an open pull request.
29+
3. Select **Start Review for PR #PR**.
30+
4. Modify and save any files you want to include in the suggestion.
31+
5. When ready, select **Suggest Changes for PR** → provide a title → **Create Code Suggestion**.
2632

27-
When selecting _locally on your machine_ you can open them on GitLens or [GitKraken Desktop](/gitkraken-client/pull-requests/#review-code-and-suggest-changes). Here, you can review the changes by selecting each file and once you are ready, you can select _Apply_ to apply to the branch you currently have checked out or select the dropdown and then _Apply to a Branch_ to apply to a new branch or select an existing branch. This will apply the patch locally.
33+
<figure>
34+
<img src="/wp-content/uploads/gl-code-suggest-create.gif" class="help-center-img img-bordered" alt="Creating a Code Suggestion in GitLens" />
35+
<figcaption style="text-align: center; color: #888">Creating a Code Suggestion</figcaption>
36+
</figure>
2837

29-
<img src="/wp-content/uploads/gl-accept-code-suggestion-from-gl.gif" class="help-center-img img-bordered">
38+
This action adds a comment on the pull request with two options:
39+
- **Code Suggestion for #PR** → review in **gitkraken.dev**
40+
- **Locally on your machine** → review in **GitLens** or **GitKraken Desktop**
3041

31-
When selecting the _Code Suggestion for #PR_ you will be taken to gitkraken.dev to review and accept the changes. Here, you can review the changes by selecting each file and once you are ready, you can select _Commit Suggestions_. This will create a new commit on the remote for the existing branch (shown under _COMMIT SUGGESTIONS TO_).
42+
<figure>
43+
<img src="/wp-content/uploads/gl-code-suggest-comment.png" class="help-center-img img-bordered" alt="Pull request comment with Code Suggestion options" />
44+
<figcaption style="text-align: center; color: #888">Pull request with Code Suggestion comment</figcaption>
45+
</figure>
46+
47+
---
3248

33-
<img src="/wp-content/uploads/gl-accept-code-suggestion.gif" class="help-center-img img-bordered">
49+
## Review and Apply Suggestions Locally
50+
51+
1. Select **Locally on your machine**.
52+
2. Open the suggestion in GitLens or [GitKraken Desktop](/gitkraken-client/pull-requests/#review-code-and-suggest-changes).
53+
3. Review changes file by file.
54+
4. Choose **Apply** to apply to your current branch, or select **Apply to a Branch** to apply to a new or existing branch.
55+
56+
<figure>
57+
<img src="/wp-content/uploads/gl-accept-code-suggestion-from-gl.gif" class="help-center-img img-bordered" alt="Applying a Code Suggestion locally in GitLens" />
58+
<figcaption style="text-align: center; color: #888">Applying a Code Suggestion locally</figcaption>
59+
</figure>
60+
61+
---
3462

35-
***
63+
## Review and Commit Suggestions in gitkraken.dev
64+
65+
1. Select **Code Suggestion for #PR** to open the suggestion in **gitkraken.dev**.
66+
2. Review each file and its proposed changes.
67+
3. When ready, select **Commit Suggestions**.
68+
69+
This creates a new commit on the remote branch (shown under **COMMIT SUGGESTIONS TO**).
70+
71+
<figure>
72+
<img src="/wp-content/uploads/gl-accept-code-suggestion.gif" class="help-center-img img-bordered" alt="Accepting and committing Code Suggestions in gitkraken.dev" />
73+
<figcaption style="text-align: center; color: #888">Committing suggestions in gitkraken.dev</figcaption>
74+
</figure>
75+
76+
---
77+
78+
## Availability
79+
80+
<div class='callout callout--basic'>
81+
<p><strong>Note:</strong> Code Suggest is currently supported only for repositories on <strong>GitHub.com</strong>.</p>
82+
</div>

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /