8000 Help text updates · github-cloud/github-plugin@96c8426 · GitHub
[go: up one dir, main page]

Skip to content

Commit 96c8426

Browse files
committed
Help text updates
1 parent de4f7a3 commit 96c8426

File tree

2 files changed

+15
-8
lines changed

2 files changed

+15
-8
lines changed
Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
<div>
2-
If you use GitHub Enterprise, specify the API end point here
2+
API endpoint of a GitHub server.
3+
4+
To use public github.com, leave this field
5+
to the default value of <code>https://api.github.com</code>.
6+
7+
Otherwise if you use GitHub Enterprise, specify its API endpoint here
38
(e.g., <code>https://ghe.acme.com/api/v3/</code>).
4-
The default value of <code>https://api.github.com</code>
5-
refers to the public github.com instance.
69
</div>
Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
<div>
2-
Cache size in MB used by GitHub client. This can speed up fetching data form GH and reduce rate limits consuming.<br/>
3-
GH + okHttp do all work for results reliability
4-
(<a href="https://developer.github.com/v3/#conditional-requests">Conditional-requests in GitHub documentation</a>)<br/>
5-
6-
Set <b>0</b> to disable this feature
2+
<p>
3+
Jenkins will use this much space in <tt>$JENKINS_HOME</tt> to cache data retrieved from GitHub API calls.
4+
A cache will help improve the performance by avoiding unnecessary data transfer, and by doing so it also
5+
makes it less likely to hit <a href="https://developer.github.com/v3/#rate-limiting">API rate limit</a>
6+
by the use of (<a href="https://developer.github.com/v3/#conditional-requests">conditional GET</a> calls.
7+
</p>
8+
<p>
9+
In an unlikely event that cache is causing a problem, set this to <b>0</b> to disable cache altogether.
10+
</p>
711
</div>

0 commit comments

Comments
 (0)
0