You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by zk...@apache.org on 2023/01/10 14:46:56 UTC

[incubator-devlake-website] branch main updated: docs: add gitlab auth docs (#383)

This is an automated email from the ASF dual-hosted git repository.

zky 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 393baa34f docs: add gitlab auth docs (#383)
393baa34f is described below

commit 393baa34f550264e5c26b547b31f4bb1e55acf0e
Author: abeizn <zi...@merico.dev>
AuthorDate: Tue Jan 10 22:46:52 2023 +0800

    docs: add gitlab auth docs (#383)
    
    * docs: add gitlab auth docs
    
    * docs: update gitlab auth docs
---
 docs/UserManuals/ConfigUI/GitLab.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/docs/UserManuals/ConfigUI/GitLab.md b/docs/UserManuals/ConfigUI/GitLab.md
index c0373bb55..f87846ece 100644
--- a/docs/UserManuals/ConfigUI/GitLab.md
+++ b/docs/UserManuals/ConfigUI/GitLab.md
@@ -26,9 +26,23 @@ 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).
 
+###### GitLab personal access tokens
+
+The following permissions are required to collect data from repositories:
+
+- `api`
+- `read_api`
+- `read_user`
+- `read_repository`
+
+You also have to double-check your GitLab user permission settings.
+
+1. Go to the Project information -> Members page of the GitLab projects you wish to collect.
+2. Check your role in this project from the Max role column. Make sure you are not the Guest role, otherwise, you will not be able to collect data from this project.
+
 ###### 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.
 
+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)