This is an automated email from the ASF dual-hosted git repository.
likyh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new 0b878b787 docs: update gitlab and github's token sections (#372)
0b878b787 is described below
commit 0b878b7872cdcdf2c3cd397ac2225dc217c37cf3
Author: Louis.z <[email protected]>
AuthorDate: Thu Jan 5 21:44:31 2023 +0800
docs: update gitlab and github's token sections (#372)
Co-authored-by: Startrekzky <[email protected]>
---
docs/UserManuals/ConfigUI/GitHub.md | 10 ++++++----
docs/UserManuals/ConfigUI/GitLab.md | 4 ++++
versioned_docs/version-v0.14/UserManuals/ConfigUI/GitLab.md | 2 ++
3 files changed, 12 insertions(+), 4 deletions(-)
diff --git a/docs/UserManuals/ConfigUI/GitHub.md
b/docs/UserManuals/ConfigUI/GitHub.md
index e06516baa..391771fc1 100644
--- a/docs/UserManuals/ConfigUI/GitHub.md
+++ b/docs/UserManuals/ConfigUI/GitHub.md
@@ -22,7 +22,7 @@ This should be a valid REST API endpoint, eg.
`https://api.github.com/`. The URL
You can use one of the following GitHub tokens: personal access tokens(PATs)
or fine-grained personal access tokens.
-###### GitHub personal access tokens(PATs)
+###### GitHub personal access tokens(Recommended)
Learn about [how to create a GitHub personal access
token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
The following permissions are required to collect data from repositories:
@@ -31,10 +31,12 @@ Learn about [how to create a GitHub personal access
token](https://docs.github.c
- `read:user`
- `read:org`
-###### Fine-grained personal access tokens(Fine-grained PATs)
+###### Fine-grained personal access tokens
+
+Note: this token doesn't support GraphQL APIs. You have to disable `Use
GraphQL APIs` on the connection page if you want to use it. However, this will
significantly increase the data collection time.
If you're concerned with giving classic PATs full unrestricted access to your
repositories, you can use fine-grained PATs announced by GitHub recently. With
fine-grained PATs, GitHub users can create read-only PATs that only have access
to repositories under certain GitHub orgs. But in order to do that, org admin
needs to enroll that org with fine-grained PATs beta feature first. Please
check [this
doc](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creati
[...]
-The token should be granted the read-only permission for the following
entities.
+The token should be granted read-only permission for the following entities.
- `Actions`
- `Contents`
- `Discussions`
@@ -42,7 +44,7 @@ The token should be granted the read-only permission for the
following entities.
- `Metadata`
- `Pull requests`
-Token Rate Limit:<br/>
+###### Rate Limit
The data collection speed is restricted by the **rate limit of [5,000
requests](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting)
per hour per token** (15,000 requests/hour if you pay for GitHub enterprise).
You can accelerate data collection by configuring _multiple_ personal access
tokens. Please note that multiple tokens should be created by different GitHub
accounts. Tokens belonging to the same GitHub account share the rate limit.
#### Use Graphql APIs
diff --git a/docs/UserManuals/ConfigUI/GitLab.md
b/docs/UserManuals/ConfigUI/GitLab.md
index 18b2d8795..c0373bb55 100644
--- a/docs/UserManuals/ConfigUI/GitLab.md
+++ b/docs/UserManuals/ConfigUI/GitLab.md
@@ -26,6 +26,10 @@ This should be a valid REST API endpoint.
GitLab personal access tokens are required to add a connection. Learn about
[how to create a GitLab personal access
token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html).
+###### Rate Limit
+The data collection speed is restricted by the **rate limit of [120,000
requests/hour](https://docs.gitlab.com/ee/user/gitlab_com/index.html#gitlabcom-specific-rate-limits)**
for GitLab Cloud. Tokens under the same IP address share the rate limit, so
the actual rate limit for your token will be lower than this number.
+
+
#### Proxy URL (Optional)
If you are behind a corporate firewall or VPN you may need to utilize a proxy
server. Enter a valid proxy server address on your network, e.g.
`http://your-proxy-server.com:1080`
diff --git a/versioned_docs/version-v0.14/UserManuals/ConfigUI/GitLab.md
b/versioned_docs/version-v0.14/UserManuals/ConfigUI/GitLab.md
index 6fb8ff09a..feef84a8e 100644
--- a/versioned_docs/version-v0.14/UserManuals/ConfigUI/GitLab.md
+++ b/versioned_docs/version-v0.14/UserManuals/ConfigUI/GitLab.md
@@ -20,6 +20,8 @@ The endpoint url should end with `/`.
#### Auth Token(s)
GitLab personal access tokens are required to add a connection. Learn about
[how to create a GitLab personal access
token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html).
+###### Rate Limit
+The data collection speed is restricted by the **rate limit of [120,000
requests/hour](https://docs.gitlab.com/ee/user/gitlab_com/index.html#gitlabcom-specific-rate-limits)**
for GitLab Cloud. Tokens under the same IP address share the rate limit, so
the actual rate limit for your token will be lower than this number.
#### Proxy URL (Optional)
If you are behind a corporate firewall or VPN you may need to utilize a proxy
server. Enter a valid proxy server address on your network, e.g.
`http://your-proxy-server.com:1080`
