Skip to content

Commit 570f8d8

Browse files
gerkaiaduh95
andcommittedOct 27, 2022
docs: clarify global gitignore and fix typos (#627)
Co-authored-by: Antoine du Hamel <[email protected]>
1 parent 474305c commit 570f8d8

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed
 

‎README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ To obtain the Jenkins API token
100100
token in the inbox that appears, and click `GENERATE`.
101101
4. Copy the generated token.
102102
5. Add it into your `ncurc` file (`~/.ncurc` or `$XDG_CONFIG_HOME/ncurc`)
103-
with `jenkins_token` as key, like this
103+
with `jenkins_token` as key, like this:
104104

105105
```json
106106
{
@@ -113,7 +113,9 @@ To obtain the Jenkins API token
113113

114114
### Make sure your credentials won't be committed
115115

116-
Put the following entries into `~/.gitignore_global`
116+
Put the following entries into your
117+
[global `gitignore` file](https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreexcludesFile)
118+
(`$XDG_CONFIG_HOME/git/ignore` or a file specified by `core.excludesFile`):
117119

118120
```
119121
# node-core-utils configuration file
@@ -122,7 +124,7 @@ Put the following entries into `~/.gitignore_global`
122124
.ncu
123125
```
124126

125-
Mind that`.ncu/land` could contain your access token since it contains the
127+
Mind that `.ncu/land` could contain your access token since it contains the
126128
serialized configurations.
127129

128130
If you ever accidentally commit your access token on GitHub, you can simply

‎docs/ncu-ci.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ and then cache the responses from Jenkins so that the next time the command
111111
is run, it picks up cached data written on disk for jobs whose results
112112
are known.
113113

114-
Note: results are cached in `${ncu_intallation_path}/.ncu/cache`, so you
114+
Note: results are cached in `${ncu_installation_path}/.ncu/cache`, so you
115115
may want to clean it up from time to time.
116116

117117
```

0 commit comments

Comments
 (0)
Please sign in to comment.