Skip to content

Commit ec8ebf7

Browse files
authored
Merge pull request #100 from Axxzilla/9.1.0-doc-updates
First pass of Doc updates
2 parents c661a6b + c35e6a0 commit ec8ebf7

12 files changed

+51
-12
lines changed

_images/Focus-View.png

-249 KB
Binary file not shown.

_images/bypass-git-hooks.png

365 KB
Loading

_images/gkc-insights-info.png

-95.1 KB
Binary file not shown.
224 KB
Loading
374 KB
Loading

gitkraken-client/commits.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,16 @@ The commit panel will then show the co-author in the history for that commit:
4747

4848
<img src='/wp-content/uploads/co-author-history.png' srcset='/wp-content/uploads/[email protected] 2x' class='img-bordered img-responsive center'>
4949

50+
### Bypass git hooks
51+
52+
There may be times when you want to skip your Git hooks when making a commit. This can be done on a commit-by-commit basis by selecting the `Commit and skip hooks` option.
53+
54+
<div class='callout callout--warning'>
55+
<p>Note 📝 - Using this option will bypass all hooks that trigger with git commit action.</p>
56+
</div>
57+
58+
<img src='/wp-content/uploads/bypass-git-hooks.png' class='img-responsive center img-bordered' />
59+
5060
***
5161

5262
<a id="commit-templates"></a>

gitkraken-client/editing-files.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,18 @@ To exit the file without saving your changes, hover over the blue dot, click the
5454

5555
Clicking the <button class='button button--success button--ui button--nolink'>Stage File</span></button> button with pending changes will give you the options to `Save and stage` or `Stage saved changes only`.
5656

57-
<img src='/wp-content/uploads/save-stage.png' srcset='/wp-content/uploads/[email protected] 2x' class='img-bordered img-responsive center'>
57+
<img src='/wp-content/uploads/save-stage.png' srcset='/wp-content/uploads/[email protected] 2x' class='img-bordered img-responsive center'>
58+
59+
## Encoding
60+
61+
All files have encoding that defines how the binary should be read.
62+
63+
GitKraken Client expects most files to use `UTF-8` file encoding. If you are using another encoding type, you can set it at the top when editing your file or from the preferences menu.
64+
65+
You can also set your file encoding to `GUESS ENCODING` and GitKraken Client will try to match the file encoding so that it is displayed correctly. Take care to select the correct file encoding when editing the file, as selecting the incorrect encoding could lead to unexpected errors.
66+
67+
<div class='callout callout--warning'>
68+
<p>Note 📝 - GitKraken Client is NOT intended to be used to change a file(s) encoding and it will not change the encoding when saving. We recommend using another editor, such as VSCode, to make file encoding changes.</p>
69+
</div>
70+
71+
<img src='/wp-content/uploads/preferences-encoding-select.png' class='img-bordered img-responsive center'>

gitkraken-client/faq.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,10 +153,12 @@ Try running [git gc](https://git-scm.com/docs/git-gc) from the terminal on this
153153

154154
***
155155

156-
### My files are not showing up as expected or are marked as binary.
157-
GitKraken Client only supports `UTF-8` file encoding. Files may display in an unexpected way or be marked a binary if files are not encoded in UTF-8.
156+
### My files are not showing up as expected or have strange characters.
157+
GitKraken Client expects most files to use `UTF-8` file encoding. If you are using another encoding type, you can set your type at the top when editing your file, or per-repository from the preferences menu.
158+
159+
You can also set your file encoding to `GUESS ENCODING` and GitKraken Client will try to match the file encoding so that it is displayed correctly. Take care to select the correct file encoding when editing the file, as selecting the incorrect encoding could lead to unexpected errors.
160+
158161

159-
You can use and [external diff and merge tools](/working-with-repositories/branching-and-merging/#external-merge-tools) to work on files using other encoding types.
160162

161163
***
162164

gitkraken-client/githooks.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Hooks are stored in the `hooks` subdirectory of the `.git` directory. This folde
2424

2525
Hooks are unique to your local repository and will not be copied over if you create a new repository. Feel free to add, change, or remove scripts from this folder as necessary.
2626

27-
<img src='/wp-content/uploads//hook_location.png' srcset='/wp-content/uploads/[email protected] 2x' class='img-responsive center img-bordered' />
27+
<img src='/wp-content/uploads/hook_location.png' srcset='/wp-content/uploads/[email protected] 2x' class='img-responsive center img-bordered' />
2828

2929
If running OSX or Linux, GitKraken Client will seamlessly detect any Git hooks in your repository if your scripts are set to be executable. If you forgot to set your files to executables, GitKraken Client will throw an error as a heads up.
3030

@@ -149,7 +149,7 @@ Here are the hooks supported by GitKraken Client. Where appropriate, beneath eac
149149

150150

151151
***
152-
## Git Hooks Example
152+
## Git hooks example
153153

154154
Git hooks are scripts that perform automated actions when a specific action is performed in GitKraken Client or the command line. The git hook name usually indicates the hook’s trigger (e.g. pre-commit).
155155

@@ -215,7 +215,7 @@ If the condition is met we move on to the next condition. If the global user.sig
215215
```
216216
If the condition is successful the script will run and the commit will be made.
217217

218-
#### Full Script
218+
#### Full script
219219
```
220220
#!/bin/bash
221221
@@ -241,4 +241,14 @@ fi
241241
```
242242

243243
### Git hook in action
244-
<img src='/wp-content/uploads/hook-in-action.gif' class='img-responsive center img-bordered' />
244+
<img src='/wp-content/uploads/hook-in-action.gif' class='img-responsive center img-bordered' />
245+
246+
### Bypass git hooks
247+
248+
There may be times when you want to skip your Git hooks when making a commit. This can be done on a commit-by-commit basis by selecting the `Commit and skip hooks` option.
249+
250+
<div class='callout callout--warning'>
251+
<p>Note 📝 - Using this option will bypass all hooks that trigger with git commit action.</p>
252+
</div>
253+
254+
<img src='/wp-content/uploads/bypass-git-hooks.png' class='img-responsive center img-bordered' />

gitkraken-client/insights.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ taxonomy:
1111

1212
GitKraken Insights is a powerful tool that helps you visualize how pull requests are merged into your repositories. It provides a visual representation of your repository's history, allowing you to see how your codebase has evolved over time. You can use this information to make informed decisions about how to improve your workflow.
1313

14-
Insights is available for Github.com, Bitbucket.org, and Gitlab.com.
14+
Insights is available for Github.com, Bitbucket.org, Gitlab.com, and Azure DevOps (Hosted).
1515

1616
<img src="/wp-content/uploads/Insights.png" class="img-responsive center img-bordered">
1717

@@ -43,6 +43,8 @@ Once you've connected to your remote hosting service, you'll be able to see the
4343
* **Open**: The total number of pull requests opened for the selected timeframe.
4444
* **Merged**: The total number of pull requests merged for the selected timeframe.
4545

46+
You can see the metrics for the last 7 or 14 days.
47+
4648
The <i class="fa-solid fa-circle-info"></i> icon will provide information about the metric.
4749

48-
<img src="/wp-content/uploads/gkc-insights-info.png" class="img-responsive center img-bordered">
50+
<img src="/wp-content/uploads/insights-metrics-info.gif" class="img-responsive center img-bordered">

0 commit comments

Comments
 (0)